The Kith Guide

The Kith Guide › Getting started

🐛 Reporting a Bug

The Report Bug button on every tool — what to include so it gets fixed fast.

In the Kith Workshop desktop app

Every Kith tool can report its own bugs. The button captures a screenshot, records which tool and version you were on, and files it — so a report takes about twenty seconds and arrives with the things a fix actually needs.

Reporting from a tool
  • Click Report Bug. On the web apps it is the tab in the bottom-left corner; in the Workshop it is on the tool you are using.
  • A screenshot of what you are looking at is captured for you.
  • Write what happened.
  • Send.

You can attach up to three screenshots if one is not enough.

Tip: Report it from the screen where it went wrong, before navigating away. The automatic screenshot is the single most useful part of the report, and it captures whatever is on screen at that moment.
What to write

The difference between a bug fixed this week and one that sits for a month is nearly always detail.

IncludeWhy it matters
What you clicked, in orderSo somebody can reproduce it. A bug nobody can reproduce cannot be fixed.
What you expected to happenSometimes the tool is right and the surprise is the real bug.
What actually happenedThe exact wording of any error message.
Whether it happens every timeIntermittent and always-broken are completely different problems.
Note: "The chef tool is broken" cannot be acted on. "Chef → Buff Browser → filter Type to Drink only, zero cards show, but there are definitely drink buffs" gets fixed.
What happens next
You reportCapturedTriagedFix proposedShipped

Your report opens a thread in the Discord bug forum. If more information is needed you will be asked there. When the fix ships you get a ping asking whether it worked.

Tip: Please answer that ping. A fix nobody confirms stays open, and the next person hits the same bug.
Reporting without the button

You can post directly in the Discord bug forum — see the Lamplighter guide. Tag it with the app it concerns; the tag is what routes it. Include a screenshot yourself, since there is nothing to capture one for you.

Before you send
  • One bug per report. Three problems in one message means two get lost.
  • Check the screenshot. It captures whatever was on screen — crop or retake if something in it is private.
  • Feature requests are welcome. Just say that is what it is, so it is not triaged as broken.