chore: add GitHub issue templates for bug reports and feature requests#1070
chore: add GitHub issue templates for bug reports and feature requests#1070aniruddhaadak80 wants to merge 1 commit intof:mainfrom
Conversation
📝 WalkthroughWalkthroughTwo new GitHub issue templates are added to the repository: a structured Bug Report template with fields for description, reproduction steps, expected behavior, and environment details; and a Feature Request template with sections for problem statement, proposed solution, and alternatives. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
There was a problem hiding this comment.
Pull request overview
This PR adds two GitHub Issue Form templates (bug_report.yml and feature_request.yml) to give contributors a structured way to submit bug reports and feature requests directly through GitHub, instead of relying solely on the external contact links defined in the existing config.yml.
Changes:
- Added
.github/ISSUE_TEMPLATE/bug_report.ymlwith fields for description, reproduction steps, expected behavior, and browser/environment. - Added
.github/ISSUE_TEMPLATE/feature_request.ymlwith fields for problem description, proposed solution, and alternatives considered.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/ISSUE_TEMPLATE/bug_report.yml |
New structured issue form for bug reports with required fields for description, reproduction steps, and expected behavior, plus optional browser/environment info. |
.github/ISSUE_TEMPLATE/feature_request.yml |
New structured issue form for feature requests with required fields for problem and solution descriptions, plus optional alternatives considered. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| name: Bug Report | ||
| description: Create a report to help us improve | ||
| title: '[Bug]: ' |
There was a problem hiding this comment.
The existing config.yml already has a "🐛 Report a Bug / Spam" contact link that opens a blank issue form at https://github.com/f/prompts.chat/issues/new?title=Report:%20. With this new bug_report.yml, users will now see both a structured "Bug Report" form template and the "Report a Bug / Spam" contact link when creating an issue, which is redundant and potentially confusing.
Consider updating .github/ISSUE_TEMPLATE/config.yml to either remove the "🐛 Report a Bug / Spam" contact link (since the structured template replaces it) or rename it to something more specific like "Report Spam" to differentiate it from the new structured bug report form.
| name: Bug Report | ||
| description: Create a report to help us improve | ||
| title: '[Bug]: ' | ||
| labels: ['bug', 'triage'] |
There was a problem hiding this comment.
The labels bug and triage referenced here must already exist in the repository for GitHub to apply them automatically when an issue is created from this template. If these labels don't exist, issues will be created successfully but without any labels applied (GitHub silently ignores non-existent labels in issue forms). Please verify that these labels exist in the repository settings, and create them if they don't.
| name: Feature Request | ||
| description: Suggest an idea for this project | ||
| title: '[Feature]: ' | ||
| labels: ['enhancement', 'triage'] |
There was a problem hiding this comment.
Same as with bug_report.yml: the labels enhancement and triage referenced here must already exist in the repository for GitHub to apply them automatically. Please verify these labels exist in the repository settings, and create them if they don't.
| labels: ['enhancement', 'triage'] |
Description
The repository currently restricts blank issues and only provides external links in the configuration file. This leaves contributors without a structured, native method to submit localized technical bug reports or feature requests directly through GitHub Forms.
This pull request introduces standard GitHub Issue Templates for both bug reports and feature requests. Implementing these templates will help maintainers receive reproducible formatting, necessary context, and structural consistency right from the start, significantly reducing the need for manual triaging.
Changes Included
Added the bug report template file to the GitHub issue templates directory.
Added the feature request template file to the GitHub issue templates directory.