# Flow diagram for selecting a GitHub issue template

Reviewer's Guide

Adds structured GitHub issue templates for bug reports, feature requests, and a generic custom issue, standardizing how users file issues.

Flow diagram for selecting a GitHub issue template

flowchart TD
  Start["User navigates to repository and clicks New issue"] --> Templates["GitHub shows available issue templates"]
  Templates -->|Bug in existing behavior| BugReport["Select Bug report template"]
  Templates -->|New idea or enhancement| FeatureRequest["Select Feature request template"]
  Templates -->|Other or unspecified issue| CustomIssue["Select Custom issue template"]

  BugReport --> BugForm["Fill sections: Describe the bug, To Reproduce, Expected behavior, Screenshots, Desktop details, Smartphone details, Additional context"]
  FeatureRequest --> FeatureForm["Fill sections: Problem description, Desired solution, Alternatives considered, Additional context"]
  CustomIssue --> CustomForm["Fill free-form content for custom issue"]

  BugForm --> Submit["Submit GitHub issue"]
  FeatureForm --> Submit
  CustomForm --> Submit

File-Level Changes

Change	Details	Files
Introduce a guided template for reporting bugs to standardize reproduction steps and environment details.	Add front-matter metadata to define a GitHub issue template for bug reports (name, about, title, labels, assignees).Define structured sections for bug description, reproduction steps, expected behavior, screenshots, and desktop/smartphone environment details.Provide an open-ended section for additional context on reported bugs.	.github/ISSUE_TEMPLATE/bug_report.md
Introduce a guided template for requesting new features with problem/solution framing.	Add front-matter metadata to define a GitHub issue template for feature requests.Define sections to capture the underlying problem, desired solution, alternative solutions considered, and additional context/screenshots.	.github/ISSUE_TEMPLATE/feature_request.md
Add a placeholder custom issue template for future customization.	Create a minimal issue template with front-matter metadata for a generic/custom issue type.Leave body intentionally empty for maintainers to define custom prompts later.	.github/ISSUE_TEMPLATE/custom.md

---

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.

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