CONTRIBUTING.md

中文|English

介绍

首先，感谢你有兴趣参与到 Grank 的维护中。 Grank 因有你的参与而变的更好。

通过阅读本文档来了解本项目的相关规范，有助于帮助你了解和参与本项目的开发，节省您与项目开发人员的时间。作为回报，我们将会帮助你解决你的问题、评估变更以及合并您的 Pull Requests。

Grank 是一个基于 Github 的开源项目，我们的项目维护者都是社区开发者，同样愿意接受来自来自社区的贡献。你可以以如下方式来参与项目，为 Grank 添砖加瓦：

• 编写 Grank 的使用教程
• 撰写 Grank 的相关文章
• 更新 Grank 的文档
• 提交 Bug issue 帮助 Grank 改进
• 提交 Feature issue ，为 Grank 提供前进的方向
• 提交可以并入 Grank 仓库的代码

关于 issue

如果您要提交 issue ，请在提交 issue 的页面选择对应的模板，请您选择后标注为中文的模板。

在提交 issue 时，请确保您在 issue 中填写了您所能够提供的所有信息，这些信息将帮助我们更好的针对您的问题提供帮助和反馈。

关于 Pull Request

如果您需要提交 PR，请确保您的 PR 满足如下要求：

1. 您的代码应是在一个新的分支，而不应是从您的 master 到 grank 的master
2. 您的代码应该是能够通过测试的，您可以通过执行pytest来进行测试
3. 您的代码应该是完善的，您需要补充相关的文档、说明、测试。
4. 如果您的代码涉及到配置文件、子命令的变更，请在 PR 中说明，或直接修改 readme.md, 并随代码一同提交。
5. 如果您的代码与某个特定的 issue 关联，请您在 PR 的描述中进行连接，方便我们了解上下文。