Skip to content

chore: improve bug report issue template#8369

Open
rreyn-bruno wants to merge 2 commits into
usebruno:mainfrom
rreyn-bruno:chore/improve-bug-report-template
Open

chore: improve bug report issue template#8369
rreyn-bruno wants to merge 2 commits into
usebruno:mainfrom
rreyn-bruno:chore/improve-bug-report-template

Conversation

@rreyn-bruno

@rreyn-bruno rreyn-bruno commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Improves the bug report issue template to make it easier to triage incoming reports.

Changes

  • Add a dedicated, required Steps to reproduce field instead of folding repro steps into the description.
  • Replace the .bru file to reproduce prompt with an optional Collection to reproduce field.
  • Set blank_issues_enabled: false so new issues go through the templates.

Summary by CodeRabbit

  • New Features
    • Updated the bug report form to request a clearer description and separate, required fields for steps to reproduce and the collection to reproduce.
    • Removed the prior dedicated file field and adjusted guidance/wording to better match the new workflow.
  • Chores
    • Disabled creating blank issues so new issues use the provided templates.

- Split reproduction into a required 'Steps to reproduce' field
- Replace the .bru file prompt with an optional 'Collection to reproduce'
- Disable blank issues to encourage use of the templates
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: cbf0dda7-53c4-4bcd-9308-dcd5b45b312e

📥 Commits

Reviewing files that changed from the base of the PR and between b1b43be and 24bbd8c.

📒 Files selected for processing (1)
  • .github/ISSUE_TEMPLATE/BugReport.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/ISSUE_TEMPLATE/BugReport.yaml

Walkthrough

The pull request updates the GitHub bug report issue form and changes the issue template config to disable blank issues.

Changes

GitHub issue template updates

Layer / File(s) Summary
Bug report form fields
.github/ISSUE_TEMPLATE/BugReport.yaml
The bug report template shortens the bug description helper text, adds a required steps-to-reproduce field, and replaces the .bru upload prompt with a collection field.
Blank issue config
.github/ISSUE_TEMPLATE/config.yaml
The GitHub issue template config changes blank issue creation from enabled to disabled.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

A bug report blooms with clearer space,
Steps and collections now take their place.
Blank issues rest, no longer free,
A tidier form for you and me.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: improving the bug report issue template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/BugReport.yaml:
- Around line 52-66: Polish the user-facing copy in the BugReport template by
fixing the typos in the textarea descriptions and removing the trailing space.
Update the text around the bug description and steps-to-reproduce fields, using
the existing YAML keys under the bug report template, so the labels and helper
text read professionally.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 0e64dc4b-3f24-4e0d-8d9c-e84466eeacbb

📥 Commits

Reviewing files that changed from the base of the PR and between 1ceea07 and b1b43be.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/BugReport.yaml
  • .github/ISSUE_TEMPLATE/config.yaml

Comment thread .github/ISSUE_TEMPLATE/BugReport.yaml Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant