SpringCloud/spring-cloud-app-broker
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document use of intellij codestyle to format import

Browse Source 
Document use of intellij codestyle to format import as expected by gradle build
This commit is contained in:
Guillaume Berche
2020-03-18 16:38:04 +01:00
committed by Alberto C. Ríos
parent 483369b8e3
commit ffa7bdd389
1 changed files with 2 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.adoc
View File

@@ -23,13 +23,8 @@ unacceptable behavior to spring-code-of-conduct@pivotal.io.
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 Spring Framework code format conventions. If you use Eclipse
you can import formatter settings using the
`eclipse-code-formatter.xml` file from the
https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring
Cloud Build] project. If using IntelliJ, you can use the
https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter
Plugin] to import the same file.
* Use the Spring Cloud App Broker format conventions documented in `src/idea/idea.xml`. If using IntelliJ, you can use import this code style through the `Editor > code style > import -> intellij idea format` settings.
* Make sure to optimize imports (e.g. in IntelliJ `Code -> Optimize Imports` or automatically through the `Optimize Imports` checkbox in the commit dialog )
* 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.