Download this template free
No sign-up needed. Word and Excel files also open in Google Docs, Google Sheets and Apple Pages/Numbers. Letter size (8.5 × 11 in).
Bug Report
Summary
[One or two sentences describing the problem.]
Steps to reproduce
- [Go to ...]
- [Click on ...]
- [Enter ...]
- [See error]
Expected result
[What should happen.]
Actual result
[What actually happens, including exact error messages.]
Environment
Attachments
[Screenshots, screen recording, console logs, network logs]
Additional notes
[Workarounds, when it started, related issues]
Preview of the template. Highlighted [brackets] show text to replace.
How to write a bug report
- Write a specific title. “Checkout button does nothing on iPhone Safari when a coupon is applied” beats “Checkout broken”.
- List the exact steps to make the bug happen, starting from a known point such as “Log in as a test customer”.
- Describe expected vs. actual results. This makes the problem unambiguous.
- Include the environment: device, OS, browser and version, app version and account type.
- Attach evidence: screenshots, a short screen recording and any error messages or console logs.
- Rate severity and priority.
- Check for duplicates before you submit.
Severity levels
| Severity | Meaning | Example |
|---|---|---|
| Critical | System down, data loss, security issue, no workaround | Checkout fails for all users |
| High | Major feature broken, poor workaround | Password reset emails not sent |
| Medium | Feature partly broken, workaround exists | Filter resets after going back |
| Low | Cosmetic or minor issue | Typo, misaligned icon |
Tips
- Reproduce it first. Try at least twice and note how often it happens.
- Stick to facts. Describe what happened, not what you think the cause is.
- One bug per report.
- Use the Markdown version to paste straight into GitHub Issues, GitLab or Jira.
Frequently asked questions
What makes a good bug report?
A specific title, exact steps to reproduce, what you expected versus what happened, details of your environment, and screenshots or logs. The goal is for a developer to see the bug for themselves without needing to ask you questions.
What is the difference between severity and priority?
Severity describes how bad the impact is, for example whether the whole site is down or a label is misaligned. Priority describes how soon it should be fixed, based on business needs. A low-severity typo on the homepage might still be high priority.
Should I report one bug per ticket?
Yes. One bug per report makes it easier to track, assign, fix and verify. Link related reports together if needed.
Related templates and guides
Website Launch Checklist
Over 60 checks to run before, during and after launch, covering content, functionality, SEO, performance, accessibility, security and legal pages.
TemplateREADME Template
A clear README.md for any software project, with the sections developers look for first, ready to download as Markdown and drop into your repository.
TemplateProduct Requirements Document (PRD) Template
A lean PRD that aligns product, design and engineering on the problem, goals, users, requirements, scope and how success will be measured.
TemplateAPI Documentation Template
A clear structure for documenting a REST API, with authentication, endpoints, parameters, example requests and responses, errors and rate limits.