Issue Documentation Guide

Basic Principles

• Concise and clear
• With actionable examples
• Focus on the "why"

Issue

Problem Situation

What is the specific problem?

Reproduction Method (only for issues that need and can be reproduced):

1. Step 1
2. Step 2
3. Expected result vs. actual result

Attach related code location or screenshots

Solution

[Selected approach]

Write specific resolution method and reason for adoption

Reviewed but Rejected Approaches (if any)

• Approach A: Reason for rejection
• Approach B: Reason for rejection

Impact Scope (if any)

• Affected parts