146. Contributing

Spring Cloud 是在非限制性 Apache 2.0 许可下发布的,并遵循非常标准的 Github 开发流程,使用 Github 跟踪程序解决问题并将合并请求合并到 master 中。如果您想贡献些微不足道的东西,请不要犹豫,但请遵循以下准则。

146.1 签署贡献者许可协议

在我们接受不重要的补丁或请求请求之前,我们将需要您在贡献者许可协议上签名。签署贡献者协议并不会授予任何人对主存储库的提交权,但这确实意味着我们可以接受您的贡献,并且如果您这样做,您将获得作者的荣誉。可能会要求活跃的贡献者加入核心团队,并具有合并合并请求的能力。

146.2 行为准则

该项目符合“贡献者契约” 行为守则。通过参与,您将坚持此代码。请向[email protected]报告不可接受的行为。

146.3 代码约定和内务处理

对于拉取请求,这些都不是必不可少的,但它们都会有所帮助。也可以在原始请求请求之后但在合并之前添加它们。

  • 使用 Spring Framework 代码格式约定。如果使用 Eclipse,则可以使用Spring Cloud 构建项目中的eclipse-code-formatter.xml文件导入格式设置。如果使用 IntelliJ,则可以使用Eclipse 代码格式化程序插件导入相同的文件。

  • 确保所有新的.java文件都具有简单的 Javadoc 类 Comments,并至少带有一个@author标签来标识您,并且最好至少包含有关该类用途的段落。

  • 将 ASF 许可证 HeadersComments 添加到所有新的.java文件(从项目中的现有文件复制)

  • 将您自己以@author的身份添加到您进行了实质性修改(不仅仅是外观更改)的.java 文件中。

  • 添加一些 Javadocs,如果更改名称空间,则添加一些 XSD doc 元素。

  • 进行一些单元测试也会有很大帮助。

  • 如果没有其他人在使用您的分支,请根据当前的主节点(或主项目中的其他目标分支)对其进行重新设置。

  • 编写提交消息时,请遵循these conventions,如果要解决现有问题,请在提交消息的末尾添加Fixes gh-XXXX(其中 XXXX 是问题编号)。