Improved: bug report template for improved clarity and restructured it for better user input

[ymaheshwari1]

Related Issues

Short Description and Why It's Useful

Screenshots of Visual Changes before/after (If There Are Any)

Contribution and Currently Important Rules Acceptance

• I read and followed contribution rules

[gemini-code-assist]

Summary of Changes

Hello @ymaheshwari1, I'm Gemini Code Assist¹! 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 significantly enhances the bug reporting process by transitioning the existing Markdown bug report template to a more structured and user-friendly GitHub Issue Form. This change aims to improve the quality and completeness of bug reports by guiding users through specific input fields and clearly defining required information, ultimately streamlining the debugging and resolution workflow.

Highlights

• Template Format Change: The bug report template has been completely refactored from a standard Markdown file to a structured YAML-based GitHub Issue Form, leveraging GitHub's native issue template features.
• Improved User Input: Input fields are now explicitly defined with 'textarea', 'input', and 'dropdown' types, providing clearer guidance and structure for users reporting bugs.
• Enhanced Clarity and Guidance: Each section now includes detailed descriptions and placeholders, such as example steps for reproduction and suggestions for attaching screenshots/recordings, to ensure comprehensive bug reports.
• Required Fields: Most fields, including current behavior, expected behavior, steps to reproduce, app environment, app version, and self-fix capability, are now marked as required to ensure essential information is always provided.
• Streamlined Environment Details: Specific input fields for 'App Environment' and 'App Version' replace the previous free-form 'Environment details' section, standardizing the collection of this critical information.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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

[gemini-code-assist]

Code Review

This pull request is a great improvement, converting the bug report template into a structured GitHub issue form. This will definitely help in getting clearer bug reports.

I've found a few high-severity issues where required id attributes are missing from form elements. Without these, the form will not work as expected. I've provided suggestions to fix them.

Additionally, I've pointed out a small typo and some spelling inconsistencies in the template's text to improve clarity and professionalism.

By the way, there's a small typo in the pull request title: 'restructued' should be 'restructured'.

Overall, excellent work on improving the contribution process!