You are viewing a plain text version of this content. The canonical link for it is here.

Posted to reviews@iotdb.apache.org by GitBox <gi...@apache.org> on 2021/02/16 11:47:37 UTC

[GitHub] [iotdb] sunjincheng121 commented on a change in pull request #2686: [IOTDB-1156] Add IDE instructions for Code Formatting

sunjincheng121 commented on a change in pull request #2686:
URL: https://github.com/apache/iotdb/pull/2686#discussion_r576762773



##########
File path: docs/Development/ContributeGuide.md
##########
@@ -83,6 +83,21 @@ Precautions:
 * Do not use special Unicode chars, e.g., U+FF1A 
 * Do not use the character of dollar (as we will use Latex to generate pdf files)
 
+### Code Formatting
+
+We use the [Spotless
+plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven) together with [google-java-format](https://github.com/google/google-java-format) to format our Java code. You can configure your IDE to automatically apply formatting on saving with these steps:
+
+1. Download the [google-java-format

Review comment:
       How about `More detailed setup manual`?




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org