Conversation
This comment was marked as resolved.
This comment was marked as resolved.
Reviewer's GuideAdds GitHub issue templates for bug reports, feature requests, and a generic custom issue type to standardize information collected when users file issues. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary of ChangesHello @Dargon789, 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 set of standardized issue templates to the repository. The primary goal is to enhance the quality and consistency of issue submissions by providing clear guidelines and required information for bug reports, feature requests, and general inquiries, which will streamline the overall issue management workflow. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
There was a problem hiding this comment.
Hey - I've found 3 issues, and left some high level feedback:
- The
custom.mdtemplate is currently just boilerplate; either flesh it out with a distinct purpose or drop it to avoid confusing contributors with an unhelpful option. - In
bug_report.md, consider consolidating the separate desktop and smartphone sections into a single, more generic environment section to reduce duplication and make it easier to fill in for less common platforms.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `custom.md` template is currently just boilerplate; either flesh it out with a distinct purpose or drop it to avoid confusing contributors with an unhelpful option.
- In `bug_report.md`, consider consolidating the separate desktop and smartphone sections into a single, more generic environment section to reduce duplication and make it easier to fill in for less common platforms.
## Individual Comments
### Comment 1
<location> `.github/ISSUE_TEMPLATE/bug_report.md:28` </location>
<code_context>
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
</code_context>
<issue_to_address>
**suggestion (typo):** Capitalize browser names in the example list for consistency with proper nouns.
Change this to `Browser [e.g. Chrome, Safari]` to align with standard product name capitalization.
```suggestion
- Browser [e.g. Chrome, Safari]
```
</issue_to_address>
### Comment 2
<location> `.github/ISSUE_TEMPLATE/bug_report.md:31-35` </location>
<code_context>
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
</code_context>
<issue_to_address>
**suggestion (typo):** Add spaces in device/OS example names for readability and correctness.
Please change the examples to `iPhone 6` and `iOS 8.1` to match standard product naming.
```suggestion
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone 6]
- OS: [e.g. iOS 8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
```
</issue_to_address>
### Comment 3
<location> `.github/ISSUE_TEMPLATE/feature_request.md:11` </location>
<code_context>
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
</code_context>
<issue_to_address>
**suggestion (typo):** Consider using a more standard abbreviation (e.g. "E.g." or "For example,") instead of "Ex."
You could rewrite this as `e.g., I'm always frustrated when [...]` or `For example, I'm always frustrated when [...]` to use a more conventional expression.
```suggestion
A clear and concise description of what the problem is. For example, I'm always frustrated when [...]
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Code Review
This pull request introduces issue templates for bug reports, feature requests, and a custom template. The templates are generally well-structured. My feedback focuses on improving them for better issue management by automatically assigning labels, and making the custom template more user-friendly by replacing placeholder content with a minimal structure.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
Summary by Sourcery
Add standardized GitHub issue templates for bug reports, feature requests, and custom issues.
Documentation:
Chores: