备注
这是 contributing.md 的简体中文翻译。这个链接 用来查看本翻译与 AVA 的 master 分支是否有差别(如果你没有看到contributing.md
发生变化,那就意味着这份翻译文档是最新的)。
✨ 感谢向 AVA 作出贡献! ✨
请注意,这个项目发布带有贡献者的行为准则,参与这个项目你需要同意并遵守其中的条款。
翻译:Español, Français, Italiano, 日本語, Português, Русский, 简体中文
作为 AVA 的用户你是帮助我们改进文档的最佳候选人,修改拼写错误,修复错误,更好的解释,更多的例子等等。为一些可以改进的事情提问题,帮助我们翻译文档,不管任何事情,即使是改善现在这个文档。
一些问题在创建时缺少信息,不能重现,描述太过简单无效,帮助我们将他们变得更容易处理,因为处理问题需要大量时间,我们情愿将时间花在修复缺陷和添加新功能上面。
我们总是在问题跟踪器上寻找更多的讨论意见,这是一个影响 AVA 未来发展方向的好机会。
我们有一个聊天室,可以进到里面潜水,跟我们聊天,或者帮助其他人。
- 问题跟踪器是针对问题的,请使用我们的聊天室 或者 Stack Overflow 来寻求支持。
- 在新开一个问题之前先搜索以前的问题。
- 确保你使用的是最新版本的 AVA。
- 用一个清晰和描述性好的标题。
- 包含尽可能多的信息:重现问题的步骤,错误的信息,Node.js 的版本,操作系统等。
- 在问题的描述上你花越多时间,越多的信息将给到我们。
- 最好的问题提交方式是提供一个失败的测试案例。
- 重大的修改最好是先开一个问题来进行讨论,这样可以避免你做一些不必要的工作。
- 对于长期远大的任务,你应该将你所做的工作在社区中提出来并尽快得到反馈,尽快开一个能证明你想法的最简版本的 pull request。在前期,不需要把事情做得完美,或者 100% 完成,只需要在标题添加一个 [WIP] 前缀,然后描述哪些工作你需要继续做的。这样评审人员就不会挑剔其中的小细节或者指出哪些你已经知道的改进点。
- 新功能应该具备测试和文档。
- 不要包含不相关的修改。
- 在提交 pull request 之前检查代码和运行测试,通过执行
$ npm test
命令来完成。 - 在一个主题分支 中提交 pull request 而不是 master 分支。
- 为 pull request 和 commit 使用一个清晰和描述性强的标题。
- 写一个让人信服的描述来说明为什么我们要接受你的 pull request。说服我们是你的工作,需要回答“为什么”并提供用例。
- 你可能被要求修改你的 pull request,但绝对没有必要去新开一个 pull request,只需要更新原来那个就可以了。