Revise bug report template for better guidance #663
Conversation
Updated the bug report template to improve clarity and structure.
|
🎉 Welcome @KUL236!
We appreciate your contribution! 🚀 |
WalkthroughThe GitHub bug report issue template was restructured to use a validated form-based approach. The template now defines explicit form fields (description, steps, expected, screenshots, environment) with required/optional validation rules and updated labels, replacing the previous free-form text-based layout. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~5–10 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 (3)
.github/ISSUE_TEMPLATE/bug_report.yml (3)
32-38: Consider adding an explicit "Actual Behavior" field for clarity.The template requests "Expected Behavior" but does not have an explicit field for "Actual Behavior." While the description field may capture this, having both fields side-by-side improves clarity and helps maintainers quickly understand the gap between expected and actual behavior.
Consider inserting an "Actual Behavior" field between "Steps to Reproduce" and "Expected Behavior":
- type: textarea id: steps attributes: label: Steps to Reproduce description: Provide steps to reproduce the bug. placeholder: | 1. Go to... 2. Click on... 3. See error... validations: required: true + - type: textarea + id: actual + attributes: + label: Actual Behavior + placeholder: What actually happened? + validations: + required: true + - type: textarea id: expected
6-9: Consider enhancing the initial guidance for contributors.The opening guidance ("Thank you for reporting a bug. Please fill out the details below.") is minimal. More specific guidance could improve report quality, such as encouraging users to search for existing issues or linking to contribution guidelines.
Consider expanding the initial markdown block with more context:
- type: markdown attributes: value: | - Thank you for reporting a bug. Please fill out the details below. + Thank you for reporting a bug! 🐛 + + **Before you start:** + - Please [search for existing issues](../../issues) to avoid duplicates. + - Include as much detail as possible to help us reproduce and fix the bug quickly.
3-4: Consider improving the title template for better guidance.The title template
"[Bug]: "provides minimal guidance. Users may struggle to write concise, descriptive titles that follow the pattern.Consider updating the title template to be more instructive:
-title: "[Bug]: " +title: "[Bug]: Brief description of the issue"This gives users a clear example of what the title should contain.
| - type: input | ||
| id: environment | ||
| attributes: | ||
| label: Environment | ||
| placeholder: OS, device, app version |
There was a problem hiding this comment.
Change environment field from input to textarea for comprehensive details.
The environment field uses type: input (single-line text), which may constrain users from providing complete environment information. Complex environments often require multiple lines (e.g., OS, device type, app version, browser details). This can limit the quality of bug reports.
Apply this diff to allow multi-line environment input:
- type: input
+ - type: textarea
id: environment
attributes:
label: Environment
placeholder: OS, device, app versionCommittable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
.github/ISSUE_TEMPLATE/bug_report.yml lines 48-52: the environment field is
defined as a single-line input which limits detailed multi-line environment
info; change the field's type from "input" to "textarea" so reporters can
provide multiline details (keep existing id/label/placeholder intact), and
ensure any YAML indentation and schema constraints remain valid after the
change.
|
What issue is this related to? |
2 participants
Updated the bug report template to improve clarity and structure.
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.