Writing Bug Reports

Overview

A bug report is a self-contained folder with a structured issue description, submission instructions, and supporting evidence — ready to paste into any tracker. Lead with symptoms, prove with evidence, make it easy to triage.

When to Use

• User encounters a bug, regression, crash, or unexpected behavior
• User asks to "prepare a bug report", "file an issue", or "document this bug"
• System investigation reveals a reportable defect

Not for:

• internal TODOs
• feature requests
• or project-specific issues that are tracked in team-level internal trackers
• known limitations that do not require submitting a bug report to upstream

Deliverable: Folder Structure