github issue提交Bug的格式
github issue提交Bug的格式
前言:
github早已在国内程序员中流行起来,我们经常会访问github上别人的源码或使用别人提供的插件,有时候会发现一些Bug希望作者能将其改进,这时候就可以考虑提交issue。
1 遇到问题就该立刻给作者提交issue吗?
当我们使用github上的开源代码或工具发现bug时,别急先仔细阅读文档也许是我们使用方法不对,或文档上有解决问题的信息。如果已经仔细查阅文档依旧无法解决,可以登录github查看作者是否已经发布了新版本并修复了这些bug,更新我们的下载再试。如果作者没有解决这些Bug的新发布,这个时候应该查看issue里是否有人已经提出过类似的问题,是否在提问者和作者的对话里已经给出了解决方案。如果没有相关的解决方案,这个时候尝试在网络上进行关键词搜索或在交流群里提问,如果都没有解决办法则最后考虑给作者提交issue。
我们要尽量保证不在issue上提出重复的问题,已经有解决方案的问题。这样是帮助作者把精力放在真正需要解决的问题上,也是更好的管理issue让其他使用者能更快速的查询到有用信息。
2 issue提交bug格式
这里我要强调一点,大家提交issue的时候尽量用英文,这是方便世界各地遇到类似问题的使用者能更方便获取信息,毕竟英语是更通用的语言。最近几年随着中国人使用github的增多,出现了较多中文在github上,我认为这不利于世界各地程序员的交流。
因为github是支持markdown的,所以直接按通用的markdown格式写就行了。
1 | ### Brief description of bug |
Environment部分根据实际情况把相关的工具版本号都写上,方便作者复现问题,Steps to Reproduce the Issue部分按描述一定要能复现出bug,尽量写清楚,不然别人复现不了也就难查问题。
照着上面的模板发issue,作者看了一定会认为你也是一个 爽朗的男人 吧,哈哈。