Bug 报告格式规范 / Formatting Bug Reports
Proper formatting makes bug reports easier to read and process.
模板 / Template
## 标题:[模块] 问题的简短描述
### 环境
- 设备:[型号]
- 系统:[系统版本]
- 浏览器:[浏览器名称 + 版本]
- 应用版本:[版本号]
### 复现步骤
1. 进入[页面]
2. 点击[元素]
3. 输入[值]
4. 观察[结果]
### 预期结果
清晰描述应该发生什么。
### 实际结果
实际发生了什么。如有错误信息请包含。
### 严重等级
致命 / 严重 / 中等 / 轻微 / 建议
### 附件
[截图 / 视频 / 日志]
格式规则 / Formatting Rules
标题
- 格式:[模块/区域] Bug 的简短描述
- 首字母大写
- 末尾不要句号
复现步骤
- 每步编号 - 从已知状态开始(例如:已登录、在首页) - 使用祈使句 - 测试数据要具体预期 vs 实际
- 写完整句子 - 使用现在时 - 客观不指责示例 / Examples
好的例子
标题:[搜索] 筛选"有库存"时搜索结果显示 0 条
步骤:
1. 以测试用户身份登录
2. 进入 /products
3. 搜索"无线耳机"
4. 点击筛选条件"有库存"
5. 观察结果:"找到 0 条结果"
预期:应显示标记为"有库存"的商品
实际:即使存在 15 件有库存商品,仍显示"找到 0 条结果"
严重等级:严重
附件:[显示筛选已应用且结果为 0 的截图]
差的例子
标题:搜索坏了
步骤:
1. 搜索内容
2. 不能用
预期:应该能用
实际:不能用