我们鼓励使用者为 Graver 项目做出贡献,贡献代码的规则可以参考下面的条例。
如果你碰见了一些不明白的问题或者是需要和开发组人员交流,可以通过 [email protected] 联系我们。
为了给 Graver 贡献代码,你应该打开一个终端
-
首先 fork 本项目,然后 clone 到本地的工作目录。
$ git clone https://github.com/YOUR_GITHUB_ID/Graver
-
通常一次 Pull Request 是为了解决一个 ISSUE, 已有的 ISSUE 列表可以在 这里 找到。
如果没有相关联的 ISSUE, 可以向开发组发邮件 [email protected],我们将会与你讨论这次贡献。
-
Graver 项目使用 Apache License 2.0 协议发布。因此每个文件头部信息必须带上相关协议版权信息。对于一个新文件可以通过以下链接 License 找到这个模板,将其复制在新文件的顶部即可。
-
创建新的 PR 前应该保证Build是通过的,并且是经过测试验证没有问题的。 如果你对创建 PR 有疑问,可以向开发组发邮件 [email protected]。
-
提交信息要遵守此 模板。
-
如果以上步骤都满足,就可以创建你的 PR 了。
当你创建一个PR时,请检查如下要求
- 请在本地做相关的 diff 确保代码风格没有发生改变,如果你认为代码风格有问题,创建一个单独的 PR 来修改这个问题。
- 提交代码前使用
git diff --check
命令检查下是否有多余的空白字符和换行。
如果你有其他方面的疑惑或者需要和开发人员沟通, 可以给我们发邮件 [email protected].。
如果有 ISSUE 需要提出,请遵守此 模板。