← Blog

Bug Report Template With a Complete Example

By SayCraft Team · 2026-08-22 · 9 min read

A useful bug report lets another person reproduce the defect, understand its impact, and verify the fix. Record the exact build, environment, account role, preconditions, minimal steps, expected result, actual result, frequency, and sanitized evidence. Reduce the report to a Minimal reproducible case without removing the condition that triggers the problem. Describe user or system impact before proposing severity, because priority is a separate product decision. If reproduction is intermittent, report the attempts and observed conditions instead of inventing certainty. The copyable template below also preserves owner, workaround, fix build, and retest result.

Copyable bug report template

Title: [observable problem] when [condition]
Environment/build:
Account/role and preconditions:
Minimal reproduction steps:
1.
2.
3.
Expected result:
Actual result:
Frequency:
Impact and affected workflow:
Evidence (sanitized):
Workaround:
Severity proposal and reason:
Owner:
Fix build / retest result:

Bad report versus complete example

Severity is not priority

Severity describes the observed consequence: blocked workflow, data loss, wrong result, degraded experience, or cosmetic issue. Priority is a product decision that also considers reach, timing, workaround, contractual risk, and competing work. State the impact evidence; do not mark every report “critical.”

If reproduction is intermittent, record frequency, timing, environment differences, and the last known good build. Never invent deterministic steps. Before attaching screenshots, network traces, or logs, remove tokens, personal data, customer files, and private URLs.