Skip to content

Update issue templates#523

Open
Dargon789 wants to merge 3 commits into
masterfrom
Dargon789-patch-1
Open

Update issue templates#523
Dargon789 wants to merge 3 commits into
masterfrom
Dargon789-patch-1

Conversation

@Dargon789
Copy link
Copy Markdown
Owner

@Dargon789 Dargon789 commented May 7, 2026

Summary by Sourcery

Add standardized GitHub issue templates to guide bug reports and feature requests.

Documentation:

  • Add a structured bug report template capturing reproduction steps, environment details, and context.
  • Add a feature request template covering problem context, desired solution, and alternatives.
  • Add a generic custom issue template for other types of issues.

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 7, 2026

Deployment failed with the following error:

Resource is limited - try again in 1 day (more than 100, code: "api-deployments-free-per-day").

Learn More: https://vercel.com/dargon789-forge?upgradeToPro=build-rate-limit

@vercel
Copy link
Copy Markdown

vercel Bot commented May 7, 2026

Deployment failed with the following error:

Resource is limited - try again in 24 hours (more than 100, code: "api-deployments-free-per-day").

Learn More: https://vercel.com/dargon789-forge?upgradeToPro=build-rate-limit

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 7, 2026

Reviewer's Guide

Adds standardized GitHub issue templates for bug reports, feature requests, and generic/custom issues to guide users when opening new issues.

Flow diagram for issue creation with standardized templates

flowchart TD
  A[Open repository Issues tab] --> B[Click New issue]
  B --> C{Choose issue template}
  C --> D[Bug report template]
  C --> E[Feature request template]
  C --> F[Custom issue template]

  D --> G[Fill sections:
Describe_bug
To_Reproduce
Expected_behavior
Screenshots
Desktop_info
Smartphone_info
Additional_context]

  E --> H[Fill sections:
Problem_description
Desired_solution
Alternatives_considered
Additional_context]

  F --> I[Fill generic custom issue fields]

  G --> J[Submit bug report issue]
  H --> K[Submit feature request issue]
  I --> L[Submit custom issue]

  J --> M[Issue created with standardized bug structure]
  K --> N[Issue created with standardized feature structure]
  L --> O[Issue created with custom structure]
Loading

File-Level Changes

Change Details Files
Introduce a structured bug report issue template to standardize bug reporting.
  • Add front matter metadata for a bug report template (name, about, title, labels, assignees).
  • Define sections for describing the bug, reproduction steps, expected behavior, and screenshots.
  • Add environment detail sections for desktop and smartphone contexts.
  • Include an additional context section for any extra information related to the bug.
.github/ISSUE_TEMPLATE/bug_report.md
Introduce a structured feature request issue template to standardize feature proposals.
  • Add front matter metadata for a feature request template (name, about, title, labels, assignees).
  • Define sections for problem description motivating the feature request.
  • Add sections for the desired solution and alternatives considered.
  • Include an additional context section for extra information or screenshots about the feature.
.github/ISSUE_TEMPLATE/feature_request.md
Add a generic custom issue template for miscellaneous requests.
  • Add front matter metadata for a custom issue template (name, about, title, labels, assignees).
  • Provide a blank body for teams to customize or for open-ended issue types.
.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

@snyk-io
Copy link
Copy Markdown

snyk-io Bot commented May 7, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Copy link
Copy Markdown

@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 GitHub issue templates for bug reports, feature requests, and custom issues. The review feedback suggests correcting the example operating system for the desktop section in the bug report template and replacing the placeholder description in the custom issue template with more descriptive text.

Comment thread .github/ISSUE_TEMPLATE/bug_report.md Outdated
Comment thread .github/ISSUE_TEMPLATE/custom.md Outdated
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>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 7, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sequence-js-docs Ready Ready Preview, Comment May 7, 2026 6:40am
sequence-js-web Ready Ready Preview, Comment May 7, 2026 6:40am

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

1 participant