lsm/initializr
1
0
Fork 0
mirror of https://gitee.com/dcren/initializr.git synced 2025-04-05 17:38:06 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update contributing section to mention javaformat and checkstyle

Browse Source
This commit is contained in:
Stephane Nicoll 2019-10-18 10:35:56 +02:00
parent a729fae5d3
commit 75b59394b2
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.adoc
View File

@ -26,7 +26,12 @@ given the ability to merge pull requests.
None of these is essential for a pull request, but they will all help. They can also be
added after the original pull request but before a merge.
* Use the https://github.com/spring-projects/spring-framework/wiki/Spring-Framework-Code-Style[Spring Framework code format conventions].
* We use the https://github.com/spring-io/spring-javaformat/[Spring JavaFormat] project
to apply code formatting conventions. A plugin is available for Eclipse and IntelliJ
IDEA. You can also format the code from the Maven build by running
`./mvnw io.spring.javaformat:spring-javaformat-maven-plugin:apply`.
* The build includes checkstyle rules for many of our code conventions. Run
`./mvnw validate` if you want to check you changes are compliant.
* Make sure all new `.java` files to have a simple Javadoc class comment with at least an
`@author` tag identifying you, and preferably at least a paragraph on what the class is
for.