如何寫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，錯誤信息，錯誤代碼，截圖，截屏視頻