github issue提交Bug的格式

github issue提交Bug的格式

github早已在國內程序員中流行起來,我們經常會訪問github上別人的源碼或使用別人提供的插件,有時候會發現一些Bug希望作者能將其改進,這時候就可以考慮提交issue。

遇到問題就該立刻給作者提交issue嗎?

當我們使用github上的開源代碼或工具發現bug時,別急先仔細閱讀文檔也許是我們使用方法不對,或文檔上有解決問題的信息。如果已經仔細查閱文檔依舊無法解決,可以登錄github查看作者是否已經發布了新版本並修復了這些bug,更新我們的下載再試。如果作者沒有解決這些Bug的新發布,這個時候應該查看issue裏是否有人已經提出過類似的問題,是否在提問者和作者的對話裏已經給出瞭解決方案。如果沒有相關的解決方案,這個時候嘗試在網絡上進行關鍵詞搜索或在交流羣裏提問,如果都沒有解決辦法則最後考慮給作者提交issue。
我們要儘量保證不在issue上提出重複的問題,已經有解決方案的問題。這樣是幫助作者把精力放在真正需要解決的問題上,也是更好的管理issue讓其他使用者能更快速的查詢到有用信息。

issue提交bug格式

這裏我要強調一點,大家提交issue的時候儘量用英文,這是方便世界各地遇到類似問題的使用者能更方便獲取信息,畢竟英語是更通用的語言。最近幾年隨着中國人使用github的增多,出現了較多中文在github上,我認爲這不利於世界各地程序員的交流。
因爲github是支持markdown的,所以直接按通用的markdown格式寫就行了。

### Brief description of bug
#### Self-Diagnosis
- [x] I have reviewed the documentation.
- [x] I have reviewed the Wiki.
- [x] I have tried to use the latest version.
- [x] I have searched the issues for an answer to my question. 
- [x] I have searched the web for an answer to my question.

#### Environment(for bug reports)
- [x] Operating System:
- [x] IDE version:
- [x] Plugin version:

#### My configuration/Related code

#### Steps to Reproduce the Issue

#### Current Result (Include screenshots where appropriate.)

#### Expected Result

Environment部分根據實際情況把相關的工具版本號都寫上,方便作者復現問題,Steps to Reproduce the Issue部分按描述一定要能復現出bug,儘量寫清楚,不然別人復現不了也就難查問題。
照着上面的模板發issue,作者看了一定會認爲你也是一個爽朗的男人吧,哈哈。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章