Skip to content

Conversation

@michelebastione
Copy link
Contributor

Edited the bug report and feature request github templates to help the users create more detailed reports.
Also removed the duplicate report issue template and the superfluous custom report template.

@shps951023 @izanhzh What do you think? Do you want to tweak them a little bit?

Edited the bug report and feature request github templates to guide the users in creating better reports. Also removed the duplicate report issue template and the superfluous custom report template
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @michelebastione, 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 improving the quality and clarity of issue reporting by refining the existing GitHub issue templates. The changes aim to streamline the process for users to submit more comprehensive bug reports and feature requests, thereby assisting maintainers in more efficiently understanding and addressing reported issues. Redundant and unnecessary templates have also been removed to simplify the issue creation workflow.

Highlights

  • Bug Report Template Enhancement: The bug_report.md template has been significantly updated to guide users in providing more detailed and structured information, including sections for description, expected/actual behavior, workarounds, environment details, and file uploads.
  • Feature Request Template Improvement: The feature_request.md template has been revamped to encourage comprehensive feature suggestions, now including sections for a feature summary, document formats, motivation, proposed solution, alternatives, and additional context.
  • Template Removal: The custom.md and report_issue.md templates have been removed. The report_issue.md was identified as a duplicate, and custom.md was deemed superfluous.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 issue templates for bug reports and feature requests by adding more structure and detailed sections. This will guide users to provide more complete information, which should streamline the issue management process. The removal of redundant templates is also a great cleanup. I've made a couple of minor suggestions to fix a typo and a formatting inconsistency.

@izanhzh
Copy link
Member

izanhzh commented Nov 27, 2025

@michelebastione I think this is great.

@shps951023
Copy link
Member

@michelebastione 😍 Please keep going

@michelebastione michelebastione merged commit 9287266 into mini-software:master Nov 27, 2025
3 checks passed
@michelebastione michelebastione deleted the new-report-templates branch November 27, 2025 06:13
@izanhzh
Copy link
Member

izanhzh commented Nov 29, 2025

@michelebastione I came back just to let you know that I really love the code refactoring results in version 2.0. I've been extremely busy recently and haven't had time to follow up on the improvements and adjustments in 2.0. 😁

@michelebastione
Copy link
Contributor Author

Thank you @izanhzh , I appreciate that a lot! There's still a few places I'm trying to improve on but the codebase is particularly entangled so it'll need more work, we'll see! Feel free to share more detailed feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants