diff options
| author | Yang Song <songy23@users.noreply.github.com> | 2018-02-28 13:11:01 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-02-28 13:11:01 -0800 |
| commit | 9def75782105d3e149f6a47a2939aa365a29d2c4 (patch) | |
| tree | 994bec358920409bfadd78fc998009be18773c43 /CONTRIBUTING.md | |
| parent | 88c49d464b6d4157d334a67bc8a063c0c56d5d5e (diff) | |
| download | platform_external_opencensus-java-9def75782105d3e149f6a47a2939aa365a29d2c4.tar.gz platform_external_opencensus-java-9def75782105d3e149f6a47a2939aa365a29d2c4.tar.bz2 platform_external_opencensus-java-9def75782105d3e149f6a47a2939aa365a29d2c4.zip | |
Add instruction on formatting files (#1035)
* Add instruction on formatting files
* Add a link to google-java-format
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2edc3664..58137796 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,17 @@ We follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html). Our build automatically will provide warnings for simple style issues. +Run the following command to format all files. This formatter uses +[google-java-format](https://github.com/google/google-java-format): + +### OS X or Linux + +`./gradlew goJF` + +### Windows + +`gradlew.bat goJF` + We also follow these project-specific guidelines: ### Javadoc |