-
Notifications
You must be signed in to change notification settings - Fork 74
docs: schema-driven contribution quick start (fixes #167) #404
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Nirbhik <[email protected]>
|
Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, you can find updates in the #github-notifications channel in the community Slack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @nirbhikneup, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly enhances the project's README.md by replacing an extensive schema-driven development guide with a concise 'Quick Start' section. The goal is to simplify the onboarding process for new contributors by providing clear, actionable information on how to contribute to schema-driven development, including definitions of key terms, guidance on where to make changes, and a streamlined contribution process. This change directly addresses identified onboarding gaps, making it easier for newcomers to understand and participate in the project.
Highlights
- Documentation Simplification: The primary change involves a significant refactor of the
README.mdfile, replacing a lengthy and detailed 'Schema-Driven Development Guide' with a much more concise and actionable 'Contributing: Schema-Driven Development (Quick Start)' section. - Improved Contributor Onboarding: The new quick start guide aims to improve the onboarding experience for new contributors by clarifying the distinctions between 'Definitions,' 'Schemas,' and 'Utilities' within the project's schema-driven development approach.
- Clear Contribution Pathways: The updated documentation now explicitly outlines where different types of contributions should be made, providing direct links to the relevant repositories or sections for schemas, the Meshery application, MeshKit, and the documentation website.
- Streamlined Contribution Process: A simplified, 'super short' contribution process is introduced, guiding contributors through the basic steps of making a change, running generators, and opening a pull request.
- Practical Contribution Details: The updated guide includes specific notes on the process for MeshKit version bumps and mentions OpenAPI Go codegen, providing practical details for contributors working with these aspects of the project.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request significantly improves the contributor onboarding experience by replacing a lengthy, detailed development guide in the README with a concise "Quick Start" section. The new section effectively directs newcomers to the right places for different types of contributions and provides a clear, high-level process. My main feedback is to correct a hardcoded issue number in the process description to avoid confusion for future contributors. Overall, this is a great change that makes the project more accessible.
| **Process (super short)** | ||
| 1. Make a small change (docs or a single property). | ||
| 2. Generators run locally/CI to update types/templates. | ||
| 3. Open a PR with DCO and include `Fixes #167`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The issue number #167 is specific to this pull request. To make this a generic instruction for all future contributors, please replace it with a placeholder like #<issue-number>.
| 3. Open a PR with DCO and include `Fixes #167`. | |
| 3. Open a PR with DCO and include `Fixes #<issue-number>`. |
What changed
Why
Notes
Fixes #167