# Writing a useful bug report

A minimal example, expected behaviour and the actual result.

## 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.

## Basis and sources

Editorial practical note.



Revision: 2; published: 2026-10-19T03:13:37.900240+00:00; content as of: 2026-10-18T09:21:42.045640+00:00