Bug 报告要求 / Bug Report Requirements
A well-written bug report helps developers understand, reproduce, and fix issues quickly.
Bug 报告结构 / Bug Report Anatomy
必填字段 / Required Fields
| 字段 | 要求 | 示例 |
|---|---|---|
| 标题 | 清晰、具体、包含模块 | [登录] Facebook 登录返回 500 错误 |
| 环境 | 设备、系统、浏览器、版本 | iPhone 14, iOS 17.2, Safari |
| 复现步骤 | 编号、精确、完整 | 1. 打开应用 2. 点击登录 3. 选择 Facebook |
| 预期结果 | 应该发生什么 | 用户登录成功并跳转到首页 |
| 实际结果 | 实际发生了什么 | 显示错误消息"500 Internal Server Error" |
| 严重等级 | 基于影响程度 | 致命 |
| 附件 | Bug 的证据 | 错误截图、控制台日志 |
标题最佳实践 / Title Best Practices
好:[结算] 优惠码 "SAVE20" 未应用于购物车总价
差:优惠码无法使用
该做与不该做 / DOs and DON'Ts
| 该做 | 不该做 |
|---|---|
| 具体且客观 | 使用模糊描述 |
| 包含环境详情 | 假设开发人员已知 |
| 提供清晰复现步骤 | 跳过步骤,认为显而易见 |
| 附上相关证据 | 仅用文字描述 |
| 先检查是否重复 | 未经搜索直接报告 |
| 一个报告一个 Bug | 混合多个问题 |