如何写Bug报告 by Elika J. Etemad (fantasai)

如何写Bug报告

如果测试失败了，那么恭喜你，你找到了一个bug，可能是浏览器bug，可能是个特例，也可能问题出在测试案例上。

怎样的bug报告才算实用的？

实用的bug报告是...

1. 可重现-如果开发不能重现这个bug，那他很可能把它标记为“无效”，跳过它继续其他工作。

2. 专业-开发越是能及时理解并抓住重点，这个bug被修复的可能就越大。

所以bug报告的目标是...

1. 明确指出bug

2. 像开发解释bug

   
   

bug报告的总体指导方针...

• 避免重复，搜索相关的资料

• 永远在最新版上进行测试，时刻和版本管理者沟通

• 每个报告只包含一个bug，同时有两个bug会分散开发者的注意力

• 列举有用的事实，不要包含个人观点和抱怨

• 对隐私和信息安全相关的bug要明确标出
  

具体怎么写...

一个好的bug报告需要包含以下信息：

总结-好的总结让bug容易本搜索引擎找到，定义明确，言简意赅

    坏例子：Drag Crash

    好例子：Drag-selecting any page crashes Mac builds in NSGetFactory

描述-描述的目的是像开发者解释bug，内容包括：

• •     行为的抽象化总结
    

  •     怎么判断它是一个bug的
    

  •     所有相关的规范链接
    

  •      规范的解释
    

  •      其他的实现方式
    

重现方法-重现方法的目的是告诉开发者如何在自己的环境中重现bug。可以是简单的一句话，也可以是详细的步骤描述：

Step 1: Load the attached testcase in Browser XYZ

Step 2: Scroll to the bottom of the page

Step 3: Click the link

Step 4: Press tab to navigate links

测试结果-测试结果包括期望结果和实际结果两个部分，实际结果像开发者解释错在哪里，期望结果描述应有的行为。

环境和配置-bug报告必须包含bug出现的环境和环境的配置参数

附加信息-任何有用的信息，包括URL，错误信息，错误代码，截图，截屏视频