Jira bug report template
Steps to reproduce, what should have happened, what happened instead, and where. The questions a developer asks first, answered before anyone has to ask.
The template
[Area]: [what goes wrong] when [action]
- Priority
- Medium
- Labels
- needs-triage
Description
Steps to reproduce
- Go to [page or screen]
- [Do this]
- [Then this]
Expected result
[What should have happened]
Actual result
[What happened instead. Copy any error message exactly.]
Environment
- Version or build:
- Browser or device:
- Operating system:
- Test account or site (never a password):
How often
[Every time, sometimes or once. If sometimes, roughly how often.]
Screenshots and logs
[Attach a screenshot, recording or log. Remove personal data first.]
Done when
- Reproduced
- Cause noted in a comment
- Fix verified where it was reported
- Test added that would have caught it
Show it as Markdown
### Steps to reproduce
1. Go to [page or screen]
2. [Do this]
3. [Then this]
### Expected result
[What should have happened]
### Actual result
[What happened instead. Copy any error message exactly.]
### Environment
- Version or build:
- Browser or device:
- Operating system:
- Test account or site (never a password):
### How often
[Every time, sometimes or once. If sometimes, roughly how often.]
### Screenshots and logs
[Attach a screenshot, recording or log. Remove personal data first.]
### Done when
- [ ] Reproduced
- [ ] Cause noted in a comment
- [ ] Fix verified where it was reported
- [ ] Test added that would have caught it
When to use it
Use it for anything that worked, or should have worked, and does not. A report that answers these questions can be picked up without a round of questions back to the person who reported it.
If a whole service is down, use the incident template instead: an outage needs an impact, a timeline and a status more than steps to reproduce.
What each section is for
- Steps to reproduce
- Numbered, starting from somewhere anyone can reach. If the steps do not always reproduce it, say so.
- Expected result
- Separates a bug from a misunderstanding. Sometimes the expected result is the real question.
- Actual result
- The exact error text can be searched for. A paraphrase cannot.
- Environment
- Where most "works for me" answers end.
- How often
- A bug that happens now and then needs a different investigation from one that happens every time.
- Screenshots and logs
- A short recording often says more than the steps. Logs and screenshots can hold personal data, so check them first.
- Impact Detailed
- Lets whoever triages set a priority without asking.
- First seen Detailed
- A start date points to the change that caused it.
Sections marked Detailed are not in the template above. Switch them on in the generator, where you can also edit the text and the checklist.
Want this to appear automatically in Jira’s Create dialog?
Issue Templates & Create Defaults for Jira fills in the summary, description, checklist, labels and priority from a template when someone opens Jira’s own Create dialog with one of the issue types you choose. Each field it fills carries a note saying where the text came from, and once someone writes their own summary or description, the app leaves the form alone.
To take a template from this page into the app with its formatting, paste it into an issue’s description, then, as a project or Jira administrator, choose Save as template from the issue’s ••• menu.
Submitted to the Atlassian Marketplace and awaiting approval.
Other templates
Or build your own in the Jira issue template generator, and see what Jira Cloud does on its own.
- User story template User story · Acceptance criteria · Context · Out of scope
- Task template What needs doing · Why · Notes
- Incident template Impact · Started · Current status · Timeline · Workaround
- Spike template Question · Timebox · Why it matters · Output
- Epic template Goal · Problem · Scope · How we will know it worked