Bug Report Guidelines for CONTRIBUTING.md
Write effective bug report guidelines for your CONTRIBUTING.md. Include issue templates, required information, severity levels, and triage process documentation.
Detailed Explanation
Bug Report Guidelines
Good bug reports save maintainer time and lead to faster fixes. A clear bug reporting section in your contributing guide sets expectations for the information contributors should provide.
Required Information
Define what every bug report must include:
## Reporting Bugs
Please include:
1. **Summary** -- One sentence describing the bug
2. **Steps to Reproduce** -- Exact steps to trigger the issue
3. **Expected Behavior** -- What should happen
4. **Actual Behavior** -- What actually happens
5. **Environment** -- OS, browser, Node version, etc.
6. **Screenshots/Logs** -- If applicable
GitHub Issue Template
Create .github/ISSUE_TEMPLATE/bug_report.md:
name: Bug Report
description: Report a bug
labels: ["bug", "triage"]
body:
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear description of the bug
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Exact steps to trigger the bug
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
validations:
required: true
Severity Levels
Help reporters classify severity:
| Level | Description | Example |
|---|---|---|
| Critical | Application crash or data loss | App crashes on login |
| Major | Feature broken, no workaround | Cannot save settings |
| Minor | Feature broken, workaround exists | Export fails but copy works |
| Trivial | Cosmetic issue | Button misaligned by 2px |
Triage Process
Explain what happens after a bug is reported: "Maintainers will triage new bugs within one week, assign a severity label, and either fix, assign, or request more information."
Duplicate Handling
Ask reporters to search existing issues first, and explain how duplicates are handled: "If your bug is a duplicate, we will close it with a link to the original issue. This is not a dismissal -- it helps us track all reports in one place."
Use Case
A project receiving many incomplete or hard-to-reproduce bug reports, where maintainers need a structured template and clear guidelines to improve report quality.