-
-
Notifications
You must be signed in to change notification settings - Fork 4
Update issue templates #18
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.
Hello @Zochory, 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!
Summary of Changes
This pull request updates the issue templates for bug reports and feature requests. It adds predefined sections and prompts to guide users in providing the necessary information when submitting issues, aiming to improve the clarity and completeness of issue reports.
Highlights
- Bug Report Template: The bug report template now includes sections for describing the bug, steps to reproduce, expected behavior, screenshots, and details about the user's desktop and smartphone environment.
- Feature Request Template: The feature request template now includes sections for describing the problem the feature request addresses, the desired solution, alternative solutions considered, and any additional context.
Changelog
- .github/ISSUE_TEMPLATE/bug_report.md
- Added a new bug report template with predefined sections for describing the bug, steps to reproduce, expected behavior, screenshots, and environment details (lines 1-38).
- .github/ISSUE_TEMPLATE/feature_request.md
- Added a new feature request template with predefined sections for describing the problem, desired solution, alternatives considered, and additional context (lines 1-20).
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.
A template's form,
Guides thoughts through the issue's storm,
Clarity takes flight.
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 updates the issue templates for bug reports and feature requests. The changes introduce standardized formats for users to report issues and suggest new features, which should help in gathering more structured and useful information. Overall, the changes seem beneficial for the project.
Merge Readiness
The changes are straightforward and improve the issue reporting process. I don't see any immediate issues that would block merging. However, it's always good to have another reviewer double-check the templates to ensure they align with the project's needs. I am unable to directly approve the pull request, and users should have others review and approve this code before merging.
No description provided.