最近 Fair 社区一直比较活跃,每天都能收到好几个 issue 的提交。
在我看来,解决 issue 本身是一件很快乐的事情,因为可以直面用户的问题和需求,与用户直接沟通。
解决 issue 还有一个好处是,可以推动你进行自我反思,思考项目中哪些方面可以进一步优化,以方便开发者使用。
比如,经常会收到一些重复,且都是属于很基础的使用问题的 issue,那我是不是可以通过丰富日志输出来规避这类问题呢?
在日志里把自查步骤,以及 Fix 建议打印出来,那么开发者就能按照指示去解决,而不用再去提交 issue,省时省力。
当然,如果有一些问题必须要提交 issue 的话,那么就涉及到今天要聊的话题了:怎样正确地提交 issue。
通常来说,维护得好一点的开源项目,都会在 issue 的提交里为开发者创建好模板,开发者只需要按照模板的格式填写内容,然后提交即可。
但是,从实际的情况来看,20 个人提交 issue,往往只有 1 个人愿意按照模板格式填写 😂。
更糟糕的是,提交的 issue 内容,也不按照 Markdown
的格式编写,读起来很头痛。
最常见的就是,帖代码的时候,直接用文本格式进行提交。有的把代码和日志信息放到一块进行提交,需要先肉眼识别出,哪块是代码,哪块是日志信息,然后再开始分析问题。
如果想让自己的 issue 得到快速的响应和解决的话,其实只需要把自己的 issue 内容稍微优化一下即可。
一般来说,提交 issue 时,以下几点是必须的:
1、贴出自己的本地环境信息
环境信息有助于排查问题和定位问题,开发环境一致才有助于复现问题。
2、代码一定要使用 Markdown 格式提交
如果你要贴的代码超过了一行,请一定使用 Markdown 格式提交。
换位思考一下,你愿意阅读 Markdown 格式的代码还是文本格式的代码。
3、复现步骤
如果操作步骤比较复杂,可以复述一下复现步骤,有助于快速帮你定位问题。
提交 issue 本身是一件小事情,但是从这件小事情中,可以看出一个人平时的开发习惯、思考习惯,以及与人合作的态度。
所以,别偷懒。