Skip to main content

Formatting Bug Reports Bug / 报告格式规范

Proper formatting makes bug reports easier to read and process.

良好的格式让 Bug 报告更易于阅读和处理。

Template / 模板​

## Title: [Area] Short description of the issue

### Environment
- Device: [model]
- OS: [OS version]
- Browser: [browser name + version]
- App version: [version]

### Steps to Reproduce
1. Go to [page]
2. Click on [element]
3. Enter [value]
4. Observe [result]

### Expected Result
What should happen clearly described.

### Actual Result
What actually happened. Include error messages if any.

### Severity
Critical / Major / Medium / Minor / Suggestion

### Attachments
[Screenshot / Video / Log]

Formatting Rules / 格式规则​

1. Title / 标题​

  • Format: [Module/Area] Brief description of the bug
  • Capitalize first letter / 首字母大写
  • No trailing period / 末尾不要句号

2. Steps to Reproduce / 复现步骤​

  • Number each step / 每步编号
  • Start from a known state (e.g., logged in, on homepage)
  • Use imperative mood / 使用祈使句
  • Be specific about test data / 测试数据要具体

3. Expected vs Actual / 预期 vs 实际​

  • Write in complete sentences / 写完整句子
  • State in present tense / 使用现在时
  • Be objective, not accusatory / 客观不指责

Examples / 示例​

Good / 好的例子​

Title: [Search] Search results show 0 results when filtering by "In Stock"

Steps:
1. Log in as test user
2. Go to /products
3. Search for "wireless headphones"
4. Click filter "In Stock"
5. Observe results: "0 results found"

Expected: Products with "In Stock" label should be displayed
Actual: "0 results found" shown even though 15 in-stock products exist

Severity: Major
Attachments: [screenshot showing filter applied with 0 results]

Poor / 差的例子​

Title: Search broken

Steps:
1. Search something
2. It doesn't work

Expected: It should work
Actual: It doesn't