
In short
- A good bug report lets someone who wasn’t there see the problem in under five minutes.
- It has a specific title, exact steps, expected and actual results, the environment, and evidence.
- Severity says how bad the damage is; priority says how soon to fix it. They are different and both matter.
On this page
"Checkout broken, please fix ASAP." That is a real kind of bug report, and you can probably guess what happens to it. The developer opens checkout, it works, they write "can’t reproduce" and move on. The bug is real. It just needed a different card, a different country and a cart with a discount, and none of that was written down.
Finding a bug is half the job. Getting it fixed depends almost entirely on how you describe it.
01What a good bug report contains
| Field | What to write | Why it matters |
|---|---|---|
| Title | What breaks, where, and under what condition | It’s what people read in a list of fifty bugs |
| Steps to reproduce | Numbered, exact, starting from a known point | If they can’t reproduce it, they can’t fix it |
| Expected result | What should happen, ideally quoting the requirement | Shows it’s a bug, not a misunderstanding |
| Actual result | What happened, including exact error text | The facts, not your guess at the cause |
| Environment | Build, browser, device, account type, test data | Many bugs only exist in one environment |
| Evidence | Screenshot, short video, console log, request ID | Saves a round trip of questions |
| Severity and priority | How bad, and how urgent | Decides where it goes in the queue |
02Before and after
Before: "Checkout broken, please fix ASAP."
The second version is longer, but the developer can reproduce it in two minutes, and the request ID points them straight at the log line. It’s also obvious it’s a minimum-amount rule at the payment provider, not a coupon bug, which sends it to the right person first time.
03Writing titles people can scan
A good title answers: what goes wrong, where, and when. Avoid "doesn’t work", "issue with" and "error".
| Weak | Better |
|---|---|
| Login issue | Login button does nothing after a wrong password is entered twice |
| Report error | Monthly sales report shows $0 for months with a refund |
| Upload broken | Uploading a PDF over 10 MB shows a spinner forever, no error |
04Severity vs priority
Severity is about impact: how badly the bug breaks things. Priority is about urgency: how soon it should be fixed. Testers usually set severity; product owners usually set priority.
| Example | Severity | Priority |
|---|---|---|
| Payments fail for all customers | Critical | Highest |
| Company logo misspelled on the home page | Trivial | High (embarrassing, very visible) |
| Rare crash in an admin report used once a year | Major | Low |
| Tooltip wording slightly wrong | Trivial | Low |
05Habits that get bugs fixed
- Reproduce it twice before you report it. If you can only reproduce it sometimes, say so, and say how often (3 times out of 10).
- Find the smallest set of steps. Remove steps one at a time until the bug disappears. The last step you removed is often the cause.
- One bug per report. Two problems in one ticket means one gets fixed and the other gets lost when it’s closed.
- Search before you file. A duplicate wastes everyone’s time; a comment on the existing bug with your extra details helps.
- State facts, not blame. "The total is wrong" not "the developer forgot the coupon". It keeps the conversation about the bug.
- Attach the request ID or log line whenever the app shows one. It’s often the fastest path to the cause.
Before you press Submit
- The title says what, where and when, in one line
- Steps start from a known point and are numbered
- Expected and actual results are both written out
- Environment, build and test data are listed
- There is a screenshot, video or log
- It is one bug, and not a duplicate
- Severity reflects impact; priority is left to or agreed with the product owner
Frequently asked questions
What should a bug report include?
A clear title, numbered steps to reproduce, expected result, actual result, the environment (build, browser, device, data), evidence such as screenshots or logs, and severity.
What is the difference between severity and priority?
Severity is how badly the bug affects the system or users. Priority is how soon it should be fixed. A trivial bug can be high priority if it is very visible, and a severe bug can be low priority if almost nobody hits it.
What do I do if I can’t reproduce a bug every time?
Report it anyway, say how often it happens, list everything you noticed about the times it did happen, and attach logs or request IDs. Intermittent bugs are real bugs.
Should I suggest a fix in my bug report?
Only as a clearly labelled note if you are confident. Keep the main report to facts. A wrong guess can send the developer in the wrong direction.
How long should a bug report be?
As long as it takes for someone who wasn’t there to reproduce the bug without asking you a question, and no longer.
Written by
Vihari Panyam
QualityAIQ