A bug report that someone can act on
Steps, log, config diff and a small screenshot, ready to paste into the tracker.
A bug report is read by someone who was not there. They do not have your device, your account or the five minutes before it broke. A report that says "login does not work" costs them a conversation to find out what you could have written down at the time. A report with the steps, the real response, the settings that differ and one small screenshot can be picked up and fixed without a question.
This template collects those pieces as you go. You write the steps while they are fresh. You paste the log or response and format it so a person can read it. If a token or a config is involved, you decode and compare it so the difference is visible, and you shrink the screenshot so the tracker does not refuse it. At the end, everything is in one job and you copy it into the tracker in one go.
It works for QA on a phone app, a developer chasing a production report and a user sending a support request. Cut the tasks that do not apply.
Use it now
6 tasks, in the order you do them. Tasks with a tool open it with the job's files and tick themselves when you save the result.
- 1Write the steps to reproduce
- 2Format the log or response JSONJSON Formatter
- 3Decode the token that was sentJWT Decoder
- 4Diff the failing config against a working oneCompare Text
- 5Shrink the screenshotImage Compressor · For web and email (2048 px)
- 6Paste everything into the tracker
Step by step, and why the defaults are what they are
1. Write the steps to reproduce
In the job's note, write numbered steps starting from a clean state: the version, the device, the account type, then every tap or request. Add what you expected and what happened, each in one sentence.
Why this default. The first thing anyone asks is how to see it themselves. Starting from a clean state removes the doubt that it only happens on your machine, and the expected and actual lines make the bug a statement, not a feeling.
2. Format the log or response JSON
Paste it into JSON Formatter, format it with 2 spaces and copy it into the note. If it is huge, cut it down to the objects around the error and say so.
Why this default. A formatted payload can be scanned by eye and diffed. A single line of minified JSON is technically complete and practically unread. Cutting it down is kind, as long as you say what you removed. Open JSON Formatter.
3. Decode the token that was sent
If the request carried a JWT, paste it into JWT Decoder and copy the claims that matter, like expiry, audience and user id, into the note. Never post the token itself.
Why this default. Many auth bugs are an expired token, a wrong audience or a missing claim, and they are visible in two lines once the token is decoded. Decoding shows what the token says; it does not prove the token is valid. Open JWT Decoder.
4. Diff the failing config against a working one
Paste the configuration of an environment where it works on one side and the failing one on the other, in Compare Text. Copy the changed lines into the note.
Why this default. "It works on staging" is only helpful if you can say what is different. A diff reduces it from a hunt to a list. Sort keys in the JSON formatter first when the files are JSON, so the diff does not show reordering. Open Compare Text.
5. Shrink the screenshot
Run Image Compressor on the screenshot with the default "For web and email" setting. It keeps the image readable and makes it small enough that trackers and chat do not refuse it.
Why this default. A full-resolution screenshot from a high-density screen can be large for what it shows. Resizing it keeps text readable and avoids an upload that fails the one time it matters. Open Image Compressor.
Variants
A crash report
Replace the JSON step with a task to paste the stack trace and the version of the app and the operating system.
A report from a customer
Keep the steps in their words, add your reproduction below and file both. The difference between the two is often the cause.
A visual bug
Add a screenshot of the expected design next to the actual one, and the colour values of both from Color Picker.
Common problems
I cannot reproduce it twice.
Say so in the report. A bug that happens one time in five is still a bug. Write down how many times you tried and what was different when it happened.
The log contains personal data.
Remove it before pasting anywhere. Replace values with placeholders such as user-123 and say you did.
The JWT decoder shows nothing useful.
Not every token is a JWT. An opaque token is just a random string and cannot be decoded.
Questions
Is the log uploaded when I format it?
No. Formatting and comparing happen in your browser. Still, take secrets out before you share a report with anyone.
Where does the finished report go?
Wherever your team tracks bugs. TabShed does not send anything anywhere; you copy from the note and files of the job.
Can I reuse the checklist for every bug?
Yes, make a new job from the template each time. Edit the tasks if your team asks for different fields.
More in the Developer kit
- Daily scratchpad – Colours, JSON, diffs and regexes in one place, with the useful ones kept in a note.
- Release check – A short checklist plus a diff of the config that changes between environments.
- JSON to CSV for a sheet – Turn an API response into rows someone can open in a spreadsheet.