Add general issue template for GitHub issues #2684
Conversation
|
@Aarushjain2401 is attempting to deploy a commit to the Vivek Prajapati's projects Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughA new GitHub issue template file is added at Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 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
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/ISSUES_TEMPLATE/issue_template.md(1 hunks)
🔇 Additional comments (3)
.github/ISSUES_TEMPLATE/issue_template.md (3)
1-7: YAML front matter is well-structured.The configuration follows GitHub's expected format for issue templates. The
name,about,title,labels, andassigneesfields are all appropriate.
9-50: Template sections are comprehensive and well-organized.The template effectively covers the essential areas for issue reporting: type selection, description, reproduction steps, expected vs. actual behavior, proposed solutions, and additional context. The use of emojis and clear visual hierarchy improves usability, and HTML comments provide helpful guidance without cluttering the user-facing form.
1-50: Clarify discrepancy between PR description and template content.The PR description mentions sections for "Closes #999" linking, "Fixes Issue", and "Changes proposed", but the actual template includes different sections (reproduction steps, expected/actual behavior, suggested solutions, etc.). Verify that the template content aligns with the intended purpose and update the PR description accordingly if needed.
| --- | ||
| name: 📝 General Issue Template | ||
| about: Report a bug, suggest a feature, or request an enhancement | ||
| title: "[TYPE] Short issue summary" | ||
| labels: [] | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ## 🧭 Issue Type | ||
| <!-- Please select one --> | ||
| - [ ] 🐞 Bug | ||
| - [ ] 💡 Feature Request | ||
| - [ ] 🚀 Enhancement | ||
|
|
||
| --- | ||
|
|
||
| ## 📝 Description | ||
| <!-- A clear and concise description of the issue. --> | ||
|
|
||
| --- | ||
|
|
||
| ## 🔍 Steps to Reproduce (for bugs) | ||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| --- | ||
|
|
||
| ## ✅ Expected Behavior | ||
| <!-- What did you expect to happen? --> | ||
|
|
||
| --- | ||
|
|
||
| ## 🧩 Actual Behavior (for bugs) | ||
| <!-- What actually happened? Include screenshots or logs if applicable. --> | ||
|
|
||
| --- | ||
|
|
||
| ## 💡 Suggested Solution / Implementation | ||
| <!-- If you have an idea for how to fix or improve it, describe it here. --> | ||
|
|
||
| --- | ||
|
|
||
| ## 🧰 Additional Context | ||
| <!-- Add any other context, links, or screenshots about the issue here. --> | ||
|
|
||
| --- | ||
|
|
||
| ### 🏷️ Notes for Maintainers | ||
| <!-- Optional: Mention any labels or reviewers you recommend. --> |
There was a problem hiding this comment.
Critical: Directory name should be ISSUE_TEMPLATE (singular), not ISSUES_TEMPLATE.
GitHub's native issue template discovery specifically looks for .github/ISSUE_TEMPLATE/ with a singular "ISSUE". The current path .github/ISSUES_TEMPLATE/ (plural "ISSUES") will prevent GitHub from automatically recognizing this template and offering it to users.
Move this file to .github/ISSUE_TEMPLATE/issue_template.md to enable proper template discovery.
🤖 Prompt for AI Agents
.github/ISSUES_TEMPLATE/issue_template.md lines 1-50: The file is in the wrong
directory name — GitHub expects .github/ISSUE_TEMPLATE (singular). Move this
file from .github/ISSUES_TEMPLATE/issue_template.md to
.github/ISSUE_TEMPLATE/issue_template.md so GitHub will automatically discover
and present the template; ensure the filename and path are exact and update any
references if present.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
1 participant
Fixes Issue
Changes proposed
Screenshots
Note to reviewers
Summary by CodeRabbit