A useful bug report lets a developer reproduce the problem without asking you a question. This page gives you a template for one, as Markdown or as a Word document, and a form that fills it in for you.
How to use it#
- To start from a blank template, select Download template (.md) or Download template (.docx). Each section has a short note on what to write.
- Or fill in the form on this page: a title, the steps to reproduce (one per line; they are numbered for you), the expected and actual results, the environment and a severity.
- Select Use this browser's details to fill in the environment from the browser you are using: its name and version, the operating system, the window size and the language.
- Select Download report (.md), or Copy Markdown to paste it straight into GitHub, GitLab, Jira or another tracker.
What makes a report useful#
A title that says what is wrong and where: "Checkout total ignores the discount code", not "Checkout broken". Steps from a known starting point, with the data you used, so someone else sees the same thing. The expected result and the actual result side by side, with the exact error message if there was one. The environment, because many bugs happen in only one browser, at one window size or in one language. A screenshot helps too; crop it to the problem and redact anything private before attaching it.
Severity#
Critical means no workaround, or data or money at risk. Major blocks an important task but has a workaround. Minor is an inconvenience. Cosmetic is how something looks. Agreeing on these words as a team makes triage faster.
Questions#
Is what I type uploaded?#
No. The form runs in your browser and nothing you type leaves your device until you copy or download it.
Which format should I use?#
Markdown pastes cleanly into GitHub, GitLab and most trackers. Word suits teams that share documents.
What makes a bug report useful?#
Steps to reproduce, what you expected, what happened, and where it happened.
Can I attach a screenshot to the downloaded report?#
The Markdown has no attachment; add the screenshot in your tracker next to it.