Github 提交 issue 的正确姿势

简介: 最近 Fair 社区一直比较活跃,每天都能收到好几个 issue 的提交。

最近 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 本身是一件小事情,但是从这件小事情中,可以看出一个人平时的开发习惯、思考习惯,以及与人合作的态度。

所以,别偷懒。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
SQL 机器学习/深度学习 JSON
钉钉/企业微信机器人:“Github触发器”与“Issue机器人”
众所周知,在Serverless领域中,触发器是FaaS必不可少的一部分;一个FaaS平台,他的触发器数量、质量以及类型,很可能会决定这个FaaS平台是否能成为“主流”平台;因为触发器不仅仅是一种功能的体现,更是解决普遍性业务诉求的一个重要途径;目前来看,各个云厂商所提供的触发器基本上都会包括API网关触发器、对象存储触发器、时间触发器等,当然也有厂商提供一定的消息触发器、日志触发器、甚至是一些SQL相关的触发器、CDN触发器等,那么在我们的实际生产生活中,这些表面上看起来“很基础”的触发器,是否可以升级成为一个有趣的“高级触发器”呢?
504 0
|
JavaScript API
用nodejs读取github上某仓库的某条issue明细
用nodejs读取github上某仓库的某条issue明细
202 0
用nodejs读取github上某仓库的某条issue明细
|
程序员
使用代码将github仓库里某个issue同步到CSDN博客上
我是一个懒惰的程序员。我在github仓库里用issue的方式写了很多分享文章,想同步到CSDN上。但是我又不想一篇篇手动复制粘贴,因此想用代码来实现自动化。 例子: https://github.com/i042416/KnowlegeRepository/issues/2215 这是我的一个issue:
使用代码将github仓库里某个issue同步到CSDN博客上
Github issue里MVP和Stretch label的区别
Github issue里MVP和Stretch label的区别
101 0
Github issue里MVP和Stretch label的区别
|
API 索引
开发一个简单的工具,导出github仓库所有issue列表
开发一个简单的工具,导出github仓库所有issue列表
313 0
开发一个简单的工具,导出github仓库所有issue列表
|
JSON API Go
ABAP开发的Github issue备份工具
ABAP开发的Github issue备份工具
111 0
ABAP开发的Github issue备份工具
|
API
开发一个简单的工具,导出github仓库所有issue列表
Jerry有一个github仓库,专门用来存放自己的知识管理,通过一条条的issue来记录具体的知识点:https://github.com/i042416/KnowlegeRepository/issues目前已经积累了超过2000条记录了。
661 0
|
Web App开发 前端开发 程序员
使用代码将github仓库里某个issue同步到CSDN博客上
我是一个懒惰的程序员。我在github仓库里用issue的方式写了很多分享文章,想同步到CSDN上。但是我又不想一篇篇手动复制粘贴,因此想用代码来实现自动化。 例子:https://github.com/i042416/KnowlegeRepository/issues/2215 这是我的一个is...
771 0
|
前端开发 JavaScript 程序员
用GitHub Issue取代多说,是不是很厉害?
摘要: 别了,多说,拥抱Gitment。 2017年6月1日,多说正式下线,这多少让人感觉有些遗憾。在比较了多个博客评论系统,我最终选择了Gitment作为本站的博客评论系统: UI简洁,适合我的博客风格 使用GitHub账号登陆,适合技术博客 使用GitHub Issues写评论,符合程序员的习惯 1. 注册OAuth Application 因为Gitment使用了GitHub的服务,因此需要注册OAuth application。
864 0