您发现了错误或者您有一个很酷的新功能的想法?贡献代码是回馈开源社区的好方法。在深入研究代码之前,我们需要贡献者遵循一些准则,以便我们有机会掌握最新情况。
确保您有 JIRA 帐户。
确保您有 GitHub 帐户。
如果您计划实现一项新功能,那么首先在开发列表上讨论您的更改是有意义的。这样您就可以确保您不会将时间浪费在不属于 Apache Maven 范围的事情上。
提交您的问题的票证(假设尚不存在)。
清楚地描述问题,包括当它是错误时重现的步骤。
确保填写您知道存在问题的最早版本。
在 GitHub 上分叉存储库。
我们通过 GitHub 接受 Pull 请求。开发者邮件列表是贡献者沟通的主要渠道。
有一些指南可以让我们更轻松地申请 PR:
从您想要作为工作基础的位置创建一个主题分支(通常是主分支)。将您的更改推送到存储库分支中的主题分支。
提交逻辑单元。
尊重原始代码风格:通过使用相同的代码风格,补丁应该只突出实际的差异,而不会受到任何格式问题的干扰:
仅使用空格进行缩进。
创建最小差异 - 禁用保存操作,例如重新格式化源代码或组织导入。如果您认为应该重新格式化源代码,请为此更改创建单独的 PR。
在提交之前使用git diff --check
检查不必要的空格。
确保您的提交消息采用正确的格式。您的提交消息应包含 JIRA 问题的密钥。
[MSHARED-XXX] - Subject of the JIRA Ticket Optional supplemental description.
确保您已为更改添加了必要的测试 (JUnit/IT)。
使用mvn -Prun-its verify
运行所有测试,以确保没有其他内容被意外破坏。
向 Apache 组织中的存储库提交拉取请求。
更新您的 JIRA 票证并在票证中包含指向拉取请求的链接。
如果您计划定期贡献,请考虑提交贡献者许可协议。
对于注释和文档的微不足道的更改,并不总是需要在 JIRA 中创建新的票证。 在这种情况下,适合以“(doc)”而不是票号开始提交的第一行。
贡献补丁
Apache Maven 共享组件项目页面
贡献者许可协议
一般 GitHub 文档
GitHub 拉取请求文档
Apache Maven Twitter 帐户
freenode.org 上的 #Maven IRC 频道