Dargon789/forge-std

Flow diagram for selecting new GitHub issue templates

Open

#79 opened on Jun 8, 2026

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Solidity (0 forks)auto 404
bugdocumentationduplicateenhancementgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

Reviewer's Guide

Adds standardized GitHub issue templates for bug reports, feature requests, and miscellaneous/custom issues to improve project issue triage and reporting quality.

Flow diagram for selecting new GitHub issue templates

flowchart TD
  actor_developer[Developer opens New issue]
  actor_developer --> A[GitHub displays issue templates]
  A --> B[Bug_report_template]
  A --> C[Feature_request_template]
  A --> D[Custom_issue_template]

  B --> E[Submit bug issue with standardized fields]
  C --> F[Submit feature request with standardized fields]
  D --> G[Submit custom issue with freeform description]

File-Level Changes

Change Details Files
Introduce a structured template for reporting bugs to standardize information collected from users. Add a bug report issue template with predefined sections for description, reproduction steps, expected behavior, screenshots, environment details, and additional context.Preconfigure bug report issues with a default title prefix and the 'bug' label to streamline triage. .github/ISSUE_TEMPLATE/bug_report.md
Introduce a structured template for feature requests to capture problems, desired solutions, alternatives, and context. Add a feature request issue template with sections for problem description, desired solution, considered alternatives, and additional context.Preconfigure feature request issues with a default title prefix and the 'enhancement' label to classify issues automatically. .github/ISSUE_TEMPLATE/feature_request.md
Provide a generic custom issue template for reports that do not fit bug or feature categories. Add a minimal custom issue template with a description prompt for flexible issue reporting.Leave title, labels, and assignees empty to allow reporters to customize non-standard issues. .github/ISSUE_TEMPLATE/custom.md

Possibly linked issues

  • #25: The PR adds the bug, feature, and custom issue templates exactly as specified in the issue’s description.

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

Originally posted by @sourcery-ai[bot] in https://github.com/Dargon789/forge-std/issues/78#issuecomment-4610527381

Contributor guide