Skip to content

Update issue templates#118

Merged
Dargon789 merged 8 commits intomasterfrom
Dargon789-patch-2
Feb 2, 2026
Merged

Update issue templates#118
Dargon789 merged 8 commits intomasterfrom
Dargon789-patch-2

Conversation

@Dargon789
Copy link
Owner

@Dargon789 Dargon789 commented Feb 2, 2026

Summary by Sourcery

Add standardized GitHub issue templates for bug reports, feature requests, and custom issues.

Documentation:

  • Introduce structured bug report and feature request issue templates to guide users when filing GitHub issues.

Chores:

  • Add a generic custom issue template for other types of GitHub issues.

@vercel

This comment was marked as resolved.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 2, 2026

Reviewer's Guide

Adds 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

Change Details Files
Introduce a structured bug report issue template for GitHub.
  • Define front matter metadata for the bug report template including name, about, title, labels, and assignees.
  • Add guided sections prompting reporters for description, reproduction steps, expected behavior, screenshots, and environment details for desktop and mobile.
  • Provide an additional context section to capture any extra relevant information.
.github/ISSUE_TEMPLATE/bug_report.md
Introduce a structured feature request issue template for GitHub.
  • Define front matter metadata for the feature request template including name, about, title, labels, and assignees.
  • Add guided sections prompting reporters for problem description, desired solution, considered alternatives, and additional context or screenshots.
.github/ISSUE_TEMPLATE/feature_request.md
Add a placeholder custom issue template for future customization.
  • Define front matter metadata for a generic custom issue template including name, about, title, labels, and assignees.
  • Leave body empty apart from the front matter separator to allow future tailoring of the template contents.
.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

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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

  • New Bug Report Template: A new template for bug reports (bug_report.md) has been added, providing structured fields for describing bugs, reproduction steps, expected behavior, screenshots, and environment details (desktop/smartphone).
  • New Feature Request Template: A new template for feature requests (feature_request.md) has been added, guiding users to describe problems, desired solutions, considered alternatives, and any additional context.
  • New Custom Issue Template: A generic custom issue template (custom.md) has been introduced, offering a flexible starting point for other types of issues not covered by the specific bug report or feature request templates.
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

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 3 issues, and left some high level feedback:

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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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

Dargon789 and others added 7 commits February 2, 2026 14:58
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>
@Dargon789 Dargon789 merged commit 2c6a1ff into master Feb 2, 2026
8 of 12 checks passed
@Dargon789 Dargon789 deleted the Dargon789-patch-2 branch February 2, 2026 08:05
@Dargon789 Dargon789 linked an issue Feb 8, 2026 that may be closed by this pull request
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.

[vc]: #[Snyk] Security upgrade python from 3.9-slim to 3.14.2-slim#120

1 participant