Revise feature request template structure #664
Conversation
Updated feature request template with new fields and labels.
|
🎉 Welcome @KUL236!
We appreciate your contribution! 🚀 |
WalkthroughThe GitHub feature request issue template was redesigned, replacing the previous section structure with four explicit textarea fields: Feature Description, Problem Statement, Proposed Solution, and Additional Context. The template header metadata was updated with an emoji-prefixed name and revised description. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/ISSUE_TEMPLATE/feature_request.yml (1)
1-30: Consider adding placeholder text for better UX.The textarea fields lack
placeholderattributes, which could help guide contributors on what to include in each field. This is a low-priority improvement but would enhance usability.Example placeholder additions:
- type: textarea attributes: label: Feature Description description: Describe the feature clearly. + placeholder: "A clear and concise description of the feature..." validations: required: trueApply similar placeholders to other fields to provide inline guidance.
| - type: textarea | ||
| attributes: | ||
| label: Additional Context | ||
| description: Mockups, references, or examples. |
There was a problem hiding this comment.
Complete the YAML structure for the Additional Context field.
The Additional Context textarea field is incomplete—it's missing the validations section required by GitHub's issue template schema. Every textarea field must have a validations block with the required flag specified.
Apply this diff to complete the field:
- type: textarea
attributes:
label: Additional Context
description: Mockups, references, or examples.
+ validations:
+ required: falseThis ensures the template renders correctly and validates field requirements as intended.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - type: textarea | |
| attributes: | |
| label: Additional Context | |
| description: Mockups, references, or examples. | |
| - type: textarea | |
| attributes: | |
| label: Additional Context | |
| description: Mockups, references, or examples. | |
| validations: | |
| required: false |
🤖 Prompt for AI Agents
In .github/ISSUE_TEMPLATE/feature_request.yml around lines 27 to 30, the
"Additional Context" textarea field is missing the required "validations" block;
add a validations section under the attributes with a required flag (e.g.,
validations: { required: false }) and ensure correct YAML indentation so the
textarea field includes the validations key and value.
|
What issue is this related to? |
2 participants
Updated feature request template with new fields and labels.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Please include screenshots below if applicable.
Checklist:
Maintainer Checklist
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.