Skip to main content

Issue Writing Guide (Defect / Business Logic Error)

Goal and Positioning​

  • Issue is the prerequisite document for Draft. It records only a confirmed bug or business logic problem for later detailing in Draft, Plan, or Code.

Minimal Document Structure​

  • Issue name (required)
  • Brief description (required)
  • Reproduction (optional): environment / steps / expected vs actual
  • Scope of impact (optional)
  • Related items (optional: Feature / Plan / link)
  • Next action (optional: move into Plan or schedule Code directly)

Output and Filing​

  • Fill it out using the Issue Template, then move into Plan or schedule Code directly depending on scope.

Definition of Done (DoD)​

  • The issue name is clear and the brief description is clear.