Bug report

A structured description of unexpected software behaviour, complete enough for someone else to reproduce it.

A useful bug report answers three questions: what did you do, what happened, and what did you expect instead. Everything else is supporting detail.

The supporting detail that matters most is environment — which page, which browser, which viewport — and that is exactly the part humans are worst at supplying. It is also the part a widget can capture automatically without asking.

A report missing reproduction steps is not worthless, but it costs an engineer a round trip to the reporter, which usually costs a day. A form that asks for steps in a dedicated field gets them far more often than one that leaves it to a free-text box.

Why it matters

The gap between a vague report and a reproducible one is the difference between a fix this afternoon and a ticket that ages for a month.