How to write a bug report with screenshots

By Mythic Brain

A screenshot shows the state you reached. Give your teammate the steps that got you there, what you expected to see, and what the screenshot shows instead. Write the exact error message in the ticket if someone will need to search for it.

Capture the bad state before starting over

If the bug is still on screen, take a screenshot while you can. Keep the control and its result in the same frame when they explain each other. For an incorrect filter, include the selected filter and one row that breaks it. Note which build you’re using and any setting that changes the behaviour. Zoom and display scaling matter when reporting a clipped label or misaligned control.

Try to reproduce the problem once with sample data. Capture a fresh copy if the first one contains a customer name or a private address. When the problem only happens during a transition, a clip with a timestamp in the report is easier to follow than a pile of frames.

Give the picture a job in the report

Here’s a sample ticket for a filter that leaves archived rows on screen.

Archived rows remain after choosing Active

Open Projects with a mix of active and archived rows. Set the Status filter to Active.

Expected
Only projects marked Active stay in the list.

Actual
North Desk still appears with an Archived badge. The arrow in the image points to the active filter and the box marks the row that shouldn’t be there.

Name the attachment for the state it shows, such as active-filter-archived-row.png. If a second picture shows the correct state, say how you reached it. A report with both images should make it clear which is the problem and which is the reference.

Keep the evidence useful after handoff

Open the attached copy once to check that the labels read clearly and that any private details are covered. In Windbreeze, you can check and annotate the capture before attaching it. If the ticket is public, read the written steps, caption, and filename too. Each can reveal details you cropped out of the image.