Spring Cloud is released under the non-restrictive Apache 2.0 license and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want to contribute even something trivial, please do not hesitate, but follow the guidelines below.
Before we accept a non-trivial patch or pull request, we need you to sign the contributor’s agreement. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team and be given the ability to merge pull requests.
None of the following guidelines is essential for a pull request, but they all help your fellow developers understand and work with your code. They can also be added after the original pull request but before a merge.
eclipse-code-formatter.xml
file from the Spring Cloud Build project.
If using IntelliJ, you can use the Eclipse Code Formatter Plugin to import the same file..java
files have a simple Javadoc class comment with at least an @author
tag identifying you, and preferably at least a paragraph describing the class’s purpose..java
files (to do so, copy from existing files in the project).@author
to the .java files that you modify substantially (more than cosmetic changes).Fixes gh-XXXX
(where XXXX is the issue number) at the end of the commit message.