File tree 1 file changed +20
-12
lines changed
1 file changed +20
-12
lines changed Original file line number Diff line number Diff line change @@ -4,15 +4,23 @@ We definitely welcome your patches and contributions to gRPC-Spring-Boot-Starter
4
4
5
5
If you are new to github, please start by reading [ Pull Request howto] ( https://help.github.com/articles/about-pull-requests/ )
6
6
7
- ##Code Formatting
8
- Code formatting is enforced using the [ Spotless] ( https://github.com/diffplug/spotless )
9
- Gradle plugin or Maven plugin. You can use ` gradle spotlessJavaApply ` or ` mvn spotless:apply `
10
- to format new code. Formatter and import order settings for Eclipse are
11
- available in the repository under
12
- [ extra/eclipse-formatter.xml] ( extra/eclipse/eclipse-formatter.xml )
13
- and [ extra/eclipse.importorder] ( extra/eclipse/eclipse.importorder ) ,
14
- respectively.
15
-
16
- For IntelliJ IDEA there's a
17
- [ plugin] ( https://plugins.jetbrains.com/plugin/6546 ) you can use in conjunction with the
18
- Eclipse settings.
7
+ ## Code Formatting
8
+
9
+ Code formatting is enforced using the [ Spotless] ( https://github.com/diffplug/spotless ) Gradle plugin.
10
+ You can use ` gradle spotlessJavaApply ` (java only) or ` gradle spotlessApply ` (all files)
11
+ to format new code. Please run this task before submitting your pull request.
12
+
13
+ ### Eclipse
14
+
15
+ For the eclipse IDE we use the following formatter files:
16
+
17
+ * [ extra/eclipse-formatter.xml] ( extra/eclipse/eclipse-formatter.xml )
18
+ * [ extra/eclipse.importorder] ( extra/eclipse/eclipse.importorder )
19
+
20
+ These will help you maintaing the files order, if you run the formatter from eclipse.
21
+ There are slight differences to the ` spotless ` plugin so please run it before submitting your PR anyway.
22
+
23
+ ### IntelliJ IDEA
24
+
25
+ For IntelliJ IDEA there's a [ Eclipse Code Formatter plugin] ( https://plugins.jetbrains.com/plugin/6546 ) you can use in
26
+ conjunction with the Eclipse setting files.
You can’t perform that action at this time.
0 commit comments