KNOWLEDGE ABOUT SYSTEMS AND HOW THEY WORKOpen Archive
← All pages

Writing a useful bug report

A minimal example, expected behaviour and the actual result.

Revision 2 · 2026-10-19T03:13:37.900240+00:00

Brief description

State what does not work. Describe the expected and actual results without assuming a cause.

Reproducible example

Include the minimum steps that reproduce the problem. State the environment and versions. Before publishing, remove keys, session identifiers and personal data from logs.

Checks already performed

List completed checks and their results. Separate an identified cause from a hypothesis. If a change made the problem disappear, test again before calling it a fix.