正在提問時
別動輒聲稱找到 Bug
當你在使用軟件中遇到問題,除非你非常、非常的有根據,不要動輒聲稱找到了 Bug。提示:除非你能提供解決問題的源代碼補丁,或者提供迴歸測試來表明前一版本中行為不正確,否則你都多半不夠完全確信。這同樣適用在網頁和文件,如果你(聲稱)發現了文件的Bug,你應該能提供相應位置的修正或替代文件。
“可能是 Bug”需要證據
請記得,還有其他許多用戶沒遇到你發現的問題,否則你在閱讀文件或搜索網頁時就應該發現了(你在抱怨前已經做了這些,是吧?)。這也意味著很有可能是你弄錯了而不是軟件本身有問題。
如果你懷疑是 Bug,請儘量提供:
- 最小復現步驟。
- 當前版本和歷史版本的行為差異。
- 明確的預期行為依據,例如文檔或規範。
- 日誌、測試用例、補丁或失敗的迴歸測試。
指控會影響對話氣氛
編寫軟件的人總是非常辛苦地使它儘可能完美。如果你聲稱找到了 Bug,也就是在質疑他們的能力,即使你是對的,也有可能會冒犯到其中某部分人。當你在標題中嚷嚷著有Bug時,這尤其嚴重。
用謙遜但清楚的方式報告
提問時,即使你私下非常確信已經發現一個真正的 Bug,最好寫得像是你做錯了什麼。如果真的有 Bug,你會在回覆中看到這點。這樣做的話,如果真有 Bug,維護者就會向你道歉,這總比你惹惱別人然後欠別人一個道歉要好一點。
比如,把 這個庫有 Bug 改成 在這個最小示例中,2.1.0 的行為與文檔描述不一致;我是否遺漏了某個配置?。這種寫法既保留了問題的嚴重性,也給維護者留下判斷空間。