# AtomUI BUG Issue 规范

本文档定义 BUG 类型 Issue 的编写规则。BUG Issue 用于描述已存在的异常行为，重点说明发生条件、当前表现、影响和期望行为。

## 必须收集

- 问题范围：影响的功能、模块、页面或配置。
- 使用场景：用户在做什么，为什么该场景合理。
- 初始状态：关键值、配置和数据状态。
- 复现步骤：按操作顺序写清楚。
- 当前行为：实际看到什么，哪些状态发生变化。
- 问题影响：为什么这是 bug，影响了什么用户流程。
- 期望行为：同一场景下应该表现成什么样。
- 补充材料：截图、录屏、日志、版本信息，按需提供。

## 推荐结构

```markdown
# [Bug] <对象> 在 <条件> 下 <异常行为>

## 类型

Bug

## 问题描述

简述问题和影响。

## 使用场景

说明真实业务或交互场景。

## 复现步骤

1. ...
2. ...
3. ...

## 当前行为

描述实际发生的行为。

## 期望行为

描述应该表现成什么样。

## 影响范围

说明影响哪些用户、流程或配置。

## 补充信息

截图、录屏、日志、版本等。
```

## 期望行为写法

- 写结果，不写实现。
- 写用户可观察行为。
- 明确哪些状态应该变化。
- 明确哪些状态不应该变化。
- 有优先级时，写清楚不同状态下的表现。
- 默认行为需要保留时，要明确说明。

## 不要写

- 解决方案。
- API 设计。
- 代码修改建议。
- 实现路径。
- 测试计划。
- 验收清单。
- PR 描述。
- Changelog 文案。

## 检查清单

- 能看出哪里出问题。
- 能复现问题。
- 当前行为清楚。
- 用户影响清楚。
- 期望行为清楚。
- 没有混入解决方案。