Bug Report Template (Markdown)
A structured bug report that helps developers reproduce and fix issues faster. Use this format for GitHub Issues, GitLab, or any markdown-based issue tracker.
# Bug Report
## Description
Clear description of the bug.
## Steps to Reproduce
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
## Expected Behavior
What should have happened.
## Actual Behavior
What actually happened.
## Screenshots
[Attach screenshots if applicable]
## Environment
- OS:
- Browser:
- Version:
## Additional Context
Any logs, network requests, or related issues.
Writing a Good Bug Report
The difference between a bug fix in 10 minutes vs 3 days is usually the quality of the bug report. Here's what makes a good one:
Clear steps to reproduce. Numbered steps are essential. If the bug happens intermittently, say so and describe the conditions that trigger it.
Environment details matter. Include OS, browser, and version. Many bugs are environment-specific and won't reproduce on the developer's machine without these details.
Separate expected from actual. Be explicit about what you expected to happen. What seems obvious to you might not be obvious to someone else.
Related Developer Templates
Feature Request Template — Propose new functionality
Pull Request Template — PR description format
Issue Template — General issue tracker format
Release Notes Template — Changelog for users