Bug Report Requirements / Bug 报告要求报告要求
A well-written bug report helps developers understand, reproduce, and fix issues quickly.
一份优秀的 Bug 报告能帮助开发人员快速理解、复现并修复问题。Bug Report Anatomy / Bug 报告结构报告结构
Required Fields / 必填字段
| Field 字段 | Requirement 要求 | Example 示例 |
|---|---|---|
| Title 标题 | Clear, specific, includes area 清晰、具体、包含区域 | [Login] Facebook login returns 500 error / [登录] Facebook 登录返回 500 错误 |
| Environment 环境 | Device, OS, browser, version 设备、操作系统、浏览器、版本 | iPhone 14, iOS 17.2, Safari |
| Steps to Reproduce 复现步骤 | Numbered, precise, complete 编号、精确、完整 | 1. Open app 2. Tap Login 3. Select Facebook 1. 打开应用 2. 点击登录 3. 选择 Facebook |
| Expected Result 预期结果 | What should happen 应该发生什么 | User is logged in and redirected to home 用户登录成功并跳转到首页 |
| Actual Result 实际结果 | What happened instead 实际发生了什么 | Error message "500 Internal Server Error" 错误信息 "500 内部服务器错误" |
| Severity 严重等级 | Based on impact 基于影响程度 | Critical 致命 |
| Attachments 附件 | Evidence of the bug Bug 的证据 | Screenshot of error, console log 错误截图，控制台日志 |
Title Best Practices / 标题最佳实践
Good: [Checkout] Coupon code "SAVE20" not applied to cart total
Bad: Coupon not working
- Prefix with area/module / 用区域/模块前缀
- Include specific values / 包含具体数值
- Be concise but descriptive / 简洁但有描述性
- One bug per report / 每个报告只描述一个 Bug
DOs and DON'Ts / 该做与不该做
| DO 该做 | DON'T 不该做 |
|---|---|
| Be specific and factual 具体且客观 | Use vague descriptions 使用模糊描述 |
| Include environment details 包含环境细节 | Assume developers know 假设开发人员知道 |
| Provide clear reproduction steps 提供清晰的复现步骤 | Skip steps assuming they're obvious 跳过看似明显的步骤 |
| Attach relevant evidence 附上相关证据 | Only describe in text 仅用文字描述 |
| Check for duplicates first 先检查是否重复 | Report without searching first 不搜索就直接报告 |
| One bug per report 一个报告只报告一个 Bug | Combine multiple issues 合并多个问题 |