Skip to content

chore: add GitHub issue templates for bug reports and feature requests#1070

Open
aniruddhaadak80 wants to merge 1 commit intof:mainfrom
aniruddhaadak80:add-issue-templates
Open

chore: add GitHub issue templates for bug reports and feature requests#1070
aniruddhaadak80 wants to merge 1 commit intof:mainfrom
aniruddhaadak80:add-issue-templates

Conversation

@aniruddhaadak80
Copy link

@aniruddhaadak80 aniruddhaadak80 commented Mar 10, 2026

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.

Copilot AI review requested due to automatic review settings March 10, 2026 15:28
@coderabbitai
Copy link

coderabbitai bot commented Mar 10, 2026

📝 Walkthrough

Walkthrough

Two 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

Cohort / File(s) Summary
GitHub Issue Templates
.github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/feature_request.yml
Added standardized issue templates for bug reports and feature requests. Bug Report includes required fields for description, reproduction steps, and expected behavior plus optional environment details. Feature Request includes required problem and solution fields plus optional alternatives.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Hop, hop, hooray! New templates in place,
Bug reports and feature dreams now have their space!
Structured and tidy, no more stray hares,
Issues flow smoothly through GitHub's care. 🌿✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and accurately describes the main changes: adding two GitHub issue templates for bug reports and feature requests.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yml with fields for description, reproduction steps, expected behavior, and browser/environment.
  • Added .github/ISSUE_TEMPLATE/feature_request.yml with 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.

Comment on lines +1 to +3
name: Bug Report
description: Create a report to help us improve
title: '[Bug]: '
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
name: Bug Report
description: Create a report to help us improve
title: '[Bug]: '
labels: ['bug', 'triage']
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
name: Feature Request
description: Suggest an idea for this project
title: '[Feature]: '
labels: ['enhancement', 'triage']
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
labels: ['enhancement', 'triage']

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants