Skip to content

feat: add issue templates for bug reports, feature requests, discussions, proposals, and questions#86

Merged
iFurySt merged 3 commits into
AmoyLab:mainfrom
KamToHung:add_issue_template
May 17, 2025
Merged

feat: add issue templates for bug reports, feature requests, discussions, proposals, and questions#86
iFurySt merged 3 commits into
AmoyLab:mainfrom
KamToHung:add_issue_template

Conversation

@KamToHung
Copy link
Copy Markdown
Contributor

@KamToHung KamToHung commented May 15, 2025

Summary by Sourcery

New Features:

  • Add bug report, feature request, technical proposal, question, and discussion issue templates under .github/ISSUE_TEMPLATE

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented May 15, 2025

Reviewer's Guide

Introduce standardized GitHub issue templates by adding markdown files for bug reports, feature requests, proposals, questions, and discussions, each with predefined front matter and structured sections.

File-Level Changes

Change Details Files
Add bug report issue template
  • Include front matter with name, about, title prefix, labels, and assignees
  • Add duplicate-check checklist
  • Define environment section for Go version, mcp-gateway version, and OS
  • Add structured sections for describing the bug, reproduction steps, expected vs actual behavior, and possible solutions
.github/ISSUE_TEMPLATE/bug_report.md
Add feature request issue template
  • Include front matter with name, about, title prefix, labels, and assignees
  • Add duplicate-check checklist for issues and release notes
  • Define sections for solution description, use cases, complexity & risks, and external dependencies
  • Include additional context section
.github/ISSUE_TEMPLATE/feature_request.md
Add proposal issue template
  • Include front matter with name, about, title prefix, labels, and assignees
  • Add duplicate-check checklist
  • Define section for describing the technical proposal
.github/ISSUE_TEMPLATE/proposal.md
Add question issue template
  • Include front matter with name, about, title prefix, labels, and assignees
  • Add duplicate-check checklist
  • Define section for submitting questions
.github/ISSUE_TEMPLATE/question.md
Add discussion issue template
  • Include front matter with name, about, title prefix, labels, and assignees
  • Provide prompt for design discussions
.github/ISSUE_TEMPLATE/discussion.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

Copy link
Copy Markdown
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 @KamToHung - I've reviewed your changes - here's some feedback:

  • In the bug report template, consider prompting for a minimal reproducible example (e.g., code snippets or repo link) to make reproduction easier.
  • For the feature request template, it might help to add a "Motivation/Benefits" section so requesters explain why the feature is valuable.
  • The proposal template could be expanded with sections like "Background", "Architecture" and "Drawbacks" to guide a more complete design RFC.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

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.

@iFurySt iFurySt force-pushed the main branch 3 times, most recently from 5663a88 to 45d29e2 Compare May 16, 2025 08:46
Copy link
Copy Markdown
Member

@iFurySt iFurySt left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

@iFurySt iFurySt merged commit 9e58117 into AmoyLab:main May 17, 2025
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.

2 participants