Update issue templates

[Dargon789]

Summary by Sourcery

Add standardized GitHub issue templates for bug reports, feature requests, and custom issues to streamline issue creation and improve report quality.

New Features:

• Introduce a structured bug report template capturing reproduction steps, environment details, and additional context.
• Introduce a feature request template to collect problem context, desired solutions, and alternatives.
• Add a generic custom issue template for miscellaneous or future issue types.

[sourcery-ai]

Reviewer's Guide

Adds standardized GitHub issue templates for bug reports, feature requests, and a generic custom issue type to streamline issue creation and capture consistent information from reporters.

Flow diagram for selecting a GitHub issue template

flowchart TD
  A[User opens repository Issues tab] --> B[User clicks New issue]
  B --> C[GitHub shows issue template options]
  C --> D[Bug report template]
  C --> E[Feature request template]
  C --> F[Custom issue template]

  D --> D1[User fills Describe the bug]
  D1 --> D2[User fills To Reproduce steps]
  D2 --> D3[User fills Expected behavior]
  D3 --> D4[User optionally adds Screenshots]
  D4 --> D5[User fills Desktop and Smartphone details]
  D5 --> D6[User adds Additional context]
  D6 --> G[Submit issue]

  E --> E1[User describes problem context]
  E1 --> E2[User describes desired solution]
  E2 --> E3[User describes alternatives considered]
  E3 --> E4[User adds Additional context or screenshots]
  E4 --> G

  F --> F1[User describes purpose of custom issue]
  F1 --> F2[User adds free form details]
  F2 --> G

Loading

File-Level Changes

Change	Details	Files
Introduce a structured bug report issue template to standardize information collected for bugs.	Create a new bug report template with frontmatter metadata for GitHub issue forms (name, about, title, labels, assignees). Define sections prompting users for bug description, reproduction steps, expected behavior, screenshots, desktop environment details, mobile environment details, and additional context.	.github/ISSUE_TEMPLATE/bug_report.md
Introduce a structured feature request issue template to guide users when proposing enhancements.	Create a new feature request template with frontmatter metadata for GitHub issue forms. Define sections prompting users for the problem statement, desired solution, alternative solutions, and additional context or screenshots.	.github/ISSUE_TEMPLATE/feature_request.md
Add a generic custom issue template placeholder for future customization.	Create a minimal custom issue template with frontmatter metadata and no predefined body content, leaving room for project-specific fields later.	.github/ISSUE_TEMPLATE/custom.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[gemini-code-assist]

Summary of Changes

Hello @Dargon789, 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 introduces a set of standardized issue templates to enhance the issue reporting process. By providing clear structures for bug reports, feature requests, and general issues, it aims to improve the quality and consistency of submitted issues, making it easier for maintainers to understand and address them.

Highlights

• New Bug Report Template: Introduced a dedicated template for reporting bugs, guiding users to provide essential details like reproduction steps, expected behavior, and environment information.
• New Feature Request Template: Added a structured template for feature requests, prompting users to describe the problem, desired solution, and any alternatives considered.
• Generic Custom Issue Template: Included a basic custom issue template for general purposes, allowing flexibility for issues that don't fit the bug or feature categories.

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

[sourcery-ai]

Hey - I've found 1 issue, and left some high level feedback:

• Consider setting default labels (e.g., bug, enhancement) and/or assignees in the issue templates’ front matter to reduce triage overhead and ensure new issues are categorized consistently.
• The bug report template splits environment details into separate desktop and smartphone sections; you might simplify maintenance and user experience by replacing these with a single, generic environment section that covers OS, browser/app, device, and version.
• Since GitHub now supports Issue Forms, you may want to convert these markdown templates to form-based templates to enforce structure (required fields, dropdowns) and improve the quality and consistency of submitted issues.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Consider setting default labels (e.g., `bug`, `enhancement`) and/or assignees in the issue templates’ front matter to reduce triage overhead and ensure new issues are categorized consistently.
- The bug report template splits environment details into separate desktop and smartphone sections; you might simplify maintenance and user experience by replacing these with a single, generic environment section that covers OS, browser/app, device, and version.
- Since GitHub now supports Issue Forms, you may want to convert these markdown templates to form-based templates to enforce structure (required fields, dropdowns) and improve the quality and consistency of submitted issues.

## Individual Comments

### Comment 1
<location> `.github/ISSUE_TEMPLATE/bug_report.md:28` </location>
<code_context>
+**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>
**nitpick (typo):** Capitalize Safari in the example browser list.

For example, you could change it to `[e.g. stock browser, Safari]`.

```suggestion
 - Browser [e.g. stock browser, Safari]
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[gemini-code-assist]

Code Review

This pull request introduces standardized GitHub issue templates for bug reports, feature requests, and custom issues. The templates are well-structured and will help streamline the issue creation process. I've provided a few suggestions to further improve them, such as adding default labels and title prefixes for better issue triaging, clarifying an example, and making the custom template more user-friendly.