docs: added issues template

[NotYuSheng]

No description provided.

[gemini-code-assist]

Hello @NotYuSheng, 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!

Summary of Changes

Hello team, Gemini here to provide a summary of this pull request. This PR, authored by NotYuSheng, focuses on improving the issue reporting process for this repository. Based on the title and the changes introduced, the primary intent is to add structured templates for different types of issues. This will help users and contributors provide necessary information when reporting bugs, requesting features, or proposing other types of work, leading to clearer and more actionable issues.

Highlights

• Issue Templates Added: This pull request introduces a set of markdown files under the .github/ISSUE_TEMPLATE directory (or equivalent, based on the file paths provided). These files serve as templates for creating new issues on the platform, guiding the reporter to include relevant details.
• Categorized Templates: Specific templates have been added for common issue types: Bug Reports, Chore tasks, Enhancements, Feature Requests, and Research tasks. Each template is tailored with sections relevant to that category, such as 'Steps to Reproduce' for bugs or 'Acceptance Criteria' for features/enhancements.
• Improved Issue Quality: By providing these templates, the PR aims to standardize the information collected for each issue, making it easier for maintainers to understand, prioritize, and address them efficiently.

Changelog

Click here to see the changelog

• ISSUE_TEMPLATE/bug.md
  • Added a new template for reporting bugs.
  • Includes sections for Summary, Steps to Reproduce, Expected Behavior, Actual Behavior, Environment, and Notes.
• ISSUE_TEMPLATE/chore.md
  • Added a new template for defining chore tasks.
  • Includes sections for Description, a simple Checklist, and Notes.
• ISSUE_TEMPLATE/enhancement.md
  • Added a new template for proposing enhancements.
  • Includes sections for Description, Acceptance Criteria, and Notes.
• ISSUE_TEMPLATE/feature.md
  • Added a new template for requesting new features.
  • Includes sections for Description, User Story, Acceptance Criteria, and Notes.
• ISSUE_TEMPLATE/research.md
  • Added a new template for outlining research tasks.
  • Includes sections for Objective, Questions to Answer, Deliverables, and Notes.

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

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 introduces a set of well-structured GitHub issue templates for bugs, chores, enhancements, features, and research tasks. These templates are a great addition and will significantly help in standardizing issue reporting and ensuring all necessary information is captured. The templates are clear, comprehensive, and cover common use cases effectively. Overall, excellent work on improving the project's issue management process!

Summary of Findings

• File Formatting: Missing Newline: The file ISSUE_TEMPLATE/bug.md is missing a newline character at the end (EOF). While many tools handle this gracefully, it's a common convention in text files to end with a newline. This can prevent issues with some tools or scripts that process text files (e.g., cat, diff tools). This is a minor issue and was not added as a direct review comment due to the current review settings focusing on medium severity or higher.

Merge Readiness

The changes in this pull request are well-implemented and provide valuable improvements to the project's issue tracking. The new issue templates are clear and comprehensive. There is one minor formatting suggestion noted in the findings summary that the author might consider. Based on this review, the pull request appears to be in good shape for merging. As a reviewer, I am not authorized to approve the pull request, so please ensure it undergoes any further necessary review and approval processes before merging.