提交 issue 的基本礼仪是什么？

[rosu]

最近给其他项目提交 issue 的时候，心里总是七上八下的。

生怕 issue 格式、内容有什么欠妥当或是某些约定俗成的规矩没有遵守...（最基本项目的 Guidelines 是会看好几遍...）

所以特来请教各位 V2er，提交 issue 的一些正确的姿势是？

---

如果英文不怎么，需要提供相应的 中文 版本并告知原因吗？

[NonClockworkChen]

国外项目,尽量双语... 我现在用的 hexo 主题 yilia,老外都是翻译成中文来提 issue 的....

[airyland]

一般会有 issue template。能尽量提供多点信息不管有没有用也提供一下。认真就好。
反正遇到那种一句话什么也不说清楚还加个命令式请求的，我都是一律加个 yet another bad issue 然后关闭。。

[AstroProfundis]

我觉得基本上，你只要是抱着认真描述清楚问题，并且尽力让对方理解的态度去做都问题不大

比如英文水平不好放了一段机翻的内容，解释一下原因再附上中文版本（态度诚恳，且中文版本能确保能说清楚问题），我不太能想象这样的态度会被人刁难，因为你至少表现出了替看 issue 的人解决语言问题的努力，说不定还会有别人看了到顺手帮你翻译下

让人不爽的是不好好说问题趾高气扬指责别人的，和不管怎样反正我反馈了问题你就必须修复我才不管你看不看得懂的那种人

当然，有可能的话还是尽量提高下英语水平...

[U7Q5tLAex2FI0o0g]

我遇到过两种：
1、不按照 issue template 填写
2、老外的 repo 里面用全中文

[catfan]

纯英文项目不要用中文，那怕你知道那个项目的作者是中国人。关注这项目的，外国人肯定占大多数。

就算英文不好，其实只要 issue 内容用具体代码甚至图片来描述问题，把 debug 信息，错误信息，版本信息，环境信息等等都尽可能提供，基本上别人就知道你要表达什么了。根本不需要写多少英文。

[arslion]

碰见无格式粘贴一大坨代码的真不想看

[libook]

每个项目有自己的规则，发之前要仔细看。

其他的就是建议：
1. 标题要一眼就能看出是什么问题
2. 标题中最好体现分类，如[BUG]、[Feature(Request)]等等
3. 内容要提供错误的详细信息
4. 提供自己遇到问题时使用的这个项目的版本、环境及各项版本参数、操作顺序或出问题的代码上下文
5. 表述清楚自己期望得到的结果，实际与期望的偏差有哪些
6. 一切可能有助于项目维护成员解答 issue 的信息
7. 感谢
8. 最好全英文，即便是中国人的项目，因为很可能有非中国开发者也遇到了相同的问题，看到这个 issue 以及解决方案就不需要再提问了。

[flowfire]

英文不好可以机翻啊，然后注明一下自己英文不好

一般就算语法用词有问题外国人也看得懂的

标题用关键字描述问题
内容写上遇到的问题，遇到问题时自己的操作环境，做过什么操作，做过什么解决问题之类的。
如果可以的话还可以附上截图
错误代码也是帮助排查问题的利器