What makes a good bug report?
One that lets someone see the bug without follow-up questions: steps, expected and actual results, environment.
Start here
One that lets someone else see the bug for themselves without asking a single follow-up question.
The essentials
- Title that names the symptom: “Export button does nothing on large reports”, not “Export broken”
- Steps to reproduce, numbered, starting from a known state
- Expected result: what should have happened
- Actual result: what did happen, including exact error text
- Environment: app version, browser or OS, account type, data used
- Evidence: screenshot, recording, log excerpt
Nice to have
- When it started, if known
- How often it happens
- Any workaround found
- Who is affected
Avoid
Guesses presented as facts, several bugs in one report, and pasting secrets or customer personal data into the ticket.
Make it easy
Give reporters a short template. Thank them for good reports. Quality goes up quickly when people see their reports used.
Next: prioritising what comes in.