Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Feat: Update feature issue template #904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
patcher9 merged 3 commits into from
Oct 16, 2025
Merged

Feat: Update feature issue template #904

patcher9 merged 3 commits into from
Oct 16, 2025
+63 −31

Conversation

@patcher9
Copy link
Contributor

@patcher9 patcher9 commented Oct 16, 2025 •
edited by sourcery-ai bot
Loading

Important

  1. We strictly follow a issue-first approach, please first open an issue relating to this Pull Request.
  2. PR name follows conventional commit format: Feat: ... or Fix: ....

Issue number:

Overview:

Checklist

If your change doesn't seem to apply, please leave them unchecked.

  • PR name follows conventional commit format: [Feat]: ... or [Fix]: ....
  • I have reviewed the contributing guidelines
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.

Summary by Sourcery

Documentation:

  • Replace legacy markdown headings with a YAML-based issue form including dropdowns and textareas for component, feature description, rationale, additional context, pre-submission checklist, and PR willingness.

@patcher9 patcher9 requested a review from a team as a code owner October 16, 2025 08:45
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Oct 16, 2025 •
edited
Loading

Reviewer's Guide

This PR refactors the feature request issue template by migrating from a static Markdown layout to GitHub’s structured issue form schema, updating metadata, and replacing legacy sections with interactive dropdowns, textareas, and checkboxes.

File-Level Changes

Change Details Files
Updated template metadata
  • Renamed template ’name’ to include emoji and revised description field
  • Changed title prefix from '[Feat]:' to '[Feature]:' format
  • Replaced single-label string with an array of labels
 .github/ISSUE_TEMPLATE/feature-request.md
Replaced legacy Markdown sections with GitHub issue form body fields
  • Removed old problem, solution, examples, and volunteer sections
  • Added dropdown for selecting the affected component
  • Added required textareas for feature description, motivation, and optional context
  • Added pre-submission checklist as checkboxes and a willingness-to-contribute dropdown
 .github/ISSUE_TEMPLATE/feature-request.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

sourcery-ai[bot]
sourcery-ai bot reviewed Oct 16, 2025
View reviewed changes
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 there - I've reviewed your changes - here's some feedback:

  • Use “Feat:” (not “Feature:”) in the title field to match your established conventional commit prefix.
  • Add a “Related issue” input so submitters can link back to the original issue and reinforce the issue-first workflow.
  • Include a required checkbox for contributors to confirm they’ve opened an issue and reviewed the contributing guidelines.
Prompt for AI Agents 
Please address the comments from this code review:

## Overall Comments
- Use “Feat:” (not “Feature:”) in the title field to match your established conventional commit prefix.
- Add a “Related issue” input so submitters can link back to the original issue and reinforce the issue-first workflow.
- Include a required checkbox for contributors to confirm they’ve opened an issue and reviewed the contributing guidelines.
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.

@patcher9 patcher9 merged commit d6cf917 into main Oct 16, 2025
6 checks passed
@patcher9 patcher9 deleted the issue-template branch October 16, 2025 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@AmanAgarwal041 AmanAgarwal041 Awaiting requested review from AmanAgarwal041 AmanAgarwal041 is a code owner automatically assigned from openlit/litters

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@patcher9