Repository navigation
docs: add a feature request issue template - #42
Merged
Merged
Conversation
A Markdown template with Problem, Proposal and Alternatives sections, labelled enhancement with the Feature issue type. It gives feature ideas a shape next to the bug report form, and it is the kind of template GitHub's community checklist counts: the checklist ignores YAML issue forms. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
psinghal20
approved these changes
Oct 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
This adds
.github/ISSUE_TEMPLATE/feature_request.md, a short Markdown template for feature ideas, next to the bug report form from #35:An HTML comment at the top points questions to Discussions Q&A and repeats CONTRIBUTING's rule: agree the design here before writing code for anything larger than a bug fix. The template applies the
enhancementlabel and the Feature issue type.It's Markdown rather than a YAML form because GitHub's community checklist only counts Markdown templates. With only the bug form, "Issue templates" stays unmet. uv, Next.js, pydantic and FastAPI are in the same position, since they use only forms.
Preview
The template chooser (
/issues/new/choose) lists:GitHub also adds its own "Blank issue" link.
What the reporter starts with. Choosing Feature request pre-fills the issue body with the template. The HTML comments are visible while editing and disappear from the posted issue. The issue gets the
enhancementlabel and the Feature type.Example of a posted issue, using a real gap found while testing the install docs:
How it was tested
name,about,labelsandtype. GitHub's issue template docs listtitle,labels,typeandassigneesas the optional keys, next to the requirednameandabout.🤖 Generated with Claude Code
The PR appears safe to merge.
Summary
Adds a Markdown feature request template with prompts for describing an idea and tags for the resulting issue. Its Markdown format also supports GitHub’s community checklist, as noted in the PR description.
enhancementlabel andFeatureissue type.Reviews (1) · Last reviewed commit: "docs: add a feature request issue templa..."