怎样在 github 上正确的提 issue

首先,看这个项目有没有提 issue 的模板,按照模板的格式填 issue。一般来说,按照格式来填,应该可以把问题讲清楚。
如果没有 issue 模板,那么你就要讲清楚你遇到的问题和需要的帮助:
- 系统环境、语言版本、相关库版本等等信息;
【怎样在 github 上正确的提 issue 】 - 可复现的代码,jsbin 或者新建一个 repo。
在这里要注意几点:
尽可能小的抽象出问题,把不必要的代码剥离;不要搞截图;
当然,最好能够看看源码,修复一下,提个 pr。

语言的问题,我建议尽量用英文;态度不卑不亢,也不要咋咋呼呼就可以了。

PS:我觉得提 issue 最大的问题在于:如何通过文字、图片和代码,正确的描述问题。这是很多人都不具备的。


■网友
项目readme用什么语言就用什么语言,千万别搞到最后,全世界人民都看懂了但项目拥有者却看不懂,那就尴尬了
■网友
一、假如该项目有默认issue模板就按照这个模板写。多数大项目都有。我对Element UI印象比较深刻,这个团队会把别人提的中文issue翻译成英文。
二、在没有issue模板的项目中可以套用一下其他项目模板。
三、自己写issue表达清楚下面几点:
1.在什么环境/情况下遇到了什么问题。
2.如何重现该问题。
3.你希望得到什么结果。

■网友
这个我感觉是没必要的。
首先,最重要的一点是,你给人家提issue的话,一定要让人家明白你提出的issue是什么。如果说光想着语言,而不能够把问题说清楚的话,这就本末倒置了。
其次,github上面也有很多中国团队维护的项目,面对这样项目,当然是用中文好一些。
所以,不要太在乎语言,而要看自己能不能够正确提出issue。
以上是个人的看法,希望对你有帮助。

■网友
谢邀。先别太看重规范问题,看一下维护者的母语是什么,然后用这种语言说清楚问题就好。不过绝大部分情况下,都应该是英文,如果自己英文不好,多看些别人用英文写的issue就好,然后你会发现其实他们也没写得多好,毕竟就是很口语化网络化的环境,模仿一些日常口吻和掌握一些术语就基本够用。
■网友
即便是项目的作者是中国人,也最好用英文交流,这样国外的开发者也能看懂


    推荐阅读