-
Notifications
You must be signed in to change notification settings - Fork 14
Create pull_request_template.md #152
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
Conversation
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 @astomodynamics, 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 introduces a new pull request template to standardize the information provided in PR descriptions. The aim is to streamline the review process and improve clarity by guiding contributors to include essential details about their changes, test plans, and any additional context.
Highlights
- New Pull Request Template: A new file, PR_TEMPLATE/pull_request_template.md, has been added to introduce a standardized template for future pull requests.
- Standardized PR Descriptions: The template includes predefined sections such as Summary, Changes, Test Plan, and Additional Notes to ensure consistent and comprehensive information is provided by contributors.
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 introduces a template for future pull requests, which is a great step towards standardizing contributions. However, for GitHub to automatically use this template, the file needs to be placed in a specific directory. The current path PR_TEMPLATE/pull_request_template.md will not work. Please move the file to .github/pull_request_template.md (the recommended location), docs/pull_request_template.md, or the root of the repository. I've also included a suggestion to enhance the template with common sections like linking related issues and an author checklist to further improve the PR process.
| ## Summary | ||
| <!-- Provide 2-3 bullet points summarizing the key changes and their purpose --> | ||
| - | ||
| - | ||
| - | ||
|
|
||
| ## Changes | ||
| <!-- List the specific changes made, grouped by component or functionality --> | ||
| - **Component/Feature**: Description of changes | ||
| - **Another Component**: Description of changes | ||
| - | ||
|
|
||
| ## Test Plan | ||
| <!-- Checklist of tests to validate the changes --> | ||
| - [ ] Test item 1 | ||
| - [ ] Test item 2 | ||
| - [ ] Test item 3 | ||
|
|
||
| ## Additional Notes | ||
| <!-- Any additional context, design decisions, or concerns for reviewers --> |
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.
This is a good starting template. To make it more robust and useful for both authors and reviewers, I suggest adding a section for related issues and a self-review checklist for the author. This helps streamline the review process by ensuring all context is provided and preliminary checks are done.
## Summary
<!-- Provide 2-3 bullet points summarizing the key changes and their purpose -->
-
-
-
## Related Issues
<!-- Link to any related issues, e.g., "Closes #123" -->
-
## Changes
<!-- List the specific changes made, grouped by component or functionality -->
- **Component/Feature**: Description of changes
- **Another Component**: Description of changes
-
## Test Plan
<!-- Checklist of tests to validate the changes -->
- [ ] Test item 1
- [ ] Test item 2
- [ ] Test item 3
## Author Checklist
- [ ] I have performed a self-review of my own code.
- [ ] My code follows the style guidelines of this project.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have made corresponding changes to the documentation.
- [ ] My changes generate no new warnings.
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] New and existing unit tests pass locally with my changes.
## Additional Notes
<!-- Any additional context, design decisions, or concerns for reviewers -->
No description provided.