@@ -3,6 +3,28 @@ Spring Boot is released under the non-restrictive Apache 2.0 license. If you wou
3
3
to contribute something, or simply want to hack on the code this document should help
4
4
you get started.
5
5
6
+ Before we accept a non-trivial patch or pull request we will need you to sign the
7
+ [ contributor's agreement] ( https://support.springsource.com/spring_committer_signup ) .
8
+ Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we
9
+ can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join
10
+ the core team, and given the ability to merge pull requests.
11
+
12
+ ## Code Conventions and Housekeeping
13
+
14
+ None of these is essential for a pull request, but they will all help. They can also be added after the original pull
15
+ request but before a merge.
16
+
17
+ * Use the Spring Framework code format conventions. Import ` eclipse-code-formatter.xml ` from the root of the project
18
+ if you are using Eclipse. If using IntelliJ, copy ` spring-intellij-code-style.xml ` to ` ~/.IntelliJIdea*/config/codestyles `
19
+ and select spring-intellij-code-style from Settings -> Code Styles.
20
+ * Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and
21
+ preferably at least a paragraph on what the class is for.
22
+ * Add the ASF license header comment to all new .java files (copy from existing files in the project)
23
+ * Add yourself as an @author to the .java files that you modify substantially (moew than cosmetic changes).
24
+ * Add some Javadocs and, if you change the namespace, some XSD doc elements.
25
+ * A few unit tests would help a lot as well - someone has to do it.
26
+ * If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
27
+
6
28
## Working with the code
7
29
If you don't have an IDE preference we would recommend that you use
8
30
[ Spring Tools Suite] ( http://www.springsource.com/developer/sts ) or
0 commit comments