-
Notifications
You must be signed in to change notification settings - Fork 4
add pr-validation #1
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 @abhinavkumar985, 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 focuses on enhancing our development workflow by updating the GitHub issue and pull request templates. The primary goal is to provide clearer guidance for contributors, ensuring more structured and comprehensive submissions for bug reports, feature requests, and pull requests.
Highlights
- Standardized Issue Templates: I've updated the
bug_report.mdandfeature_request.mdtemplates with more descriptive fields, clearer instructions, and standardized titles. This aims to streamline issue reporting by providing better guidance for contributors. - Comprehensive Pull Request Checklist: The
PULL_REQUEST_TEMPLATE.mdhas been completely overhauled to include an extensive checklist. This new checklist covers general checks, content and documentation specifics (including guidelines forGEMINI.mdand.gemini-guidelinesfiles), and self-review steps, all designed to improve PR quality and consistency. - Improved Contributor Guidance: Overall, the changes across all templates are intended to provide clearer and more structured guidance to contributors, making it easier for them to submit well-formed issues and pull requests that align with the project's standards.
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 is currently in preview and 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 to provide feedback.
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
The pull request improves the repository's issue and pull request templates. The new PR template, with its detailed checklist, is valuable. The review includes suggestions for the PR template to enhance its clarity and maintainability.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…uctions-kit into test-pr-check
|
👍 |
Pull Request Template 🚀
Description
Please include a summary of the changes and the related issue.
Also, describe the motivation behind these changes and how they address the problem.
Fixes #(issue number)
Type of change
Checklist
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Include details on how to reproduce and test this.
Screenshots (if applicable)
Add screenshots to help explain your changes here.
Additional Notes
Anything else reviewers should know about this PR.