azkaban-aplcache

Customize code style template. Update README (#1406) * Customize …

8/28/2017 7:21:24 PM

code style template. Update README

- Modify the style template to preserve line feeds in the Javadoc. This
makes it easier to preserve the Javadoc format in the source file. This
is especially helpful given this intellij issue
"Formatting doesn't apply to javadoc in modified files"
https://youtrack.jetbrains.com/issue/IDEA-178073

- Change the name of the style config file and the style name
to reflect that it is now a customized style for the project.
And it contains styles for other languages such as JavaScript as well.

- Update the README to reference the new style file. Make it clear that
the new style need to be activated after it is imported.

- Update the README to require saveAction plugin. We have finished
auto formatting all the source files.

* Change style rules in the README file

The modification we made to the style configuration i.e. preserving line
feeds is still consistent with the Google style guide.

It's simpler to state we follow strictly the Google style.

Also added the link to the specific version of the config file our
configuration file is based on. It makes it easier to merge in new
changes to the Google style config in the future.

HappyRay

Commit: 087d2bb

Tree: bff99e4

Parents: 3089664

Changes

az-intellij-style.xml 4(+3 -1)

README.md 17(+7 -10)

Details

README.md 17(+7 -10)

diff --git a/README.md b/README.md
index 7cd85fa..96770f6 100644
--- a/README.md
+++ b/README.md
@@ -36,19 +36,16 @@ project. You can import it into your IDE using the `build.gradle` file in the ro
 Project from the Quick Start box or choose Open from the File menu and select the root `build.gradle` file.
 
 ### Code Style
-Azkaban follows Google code style. The template file, `intellij-java-google-style.xml`, can be found in the root 
-directory.
+Azkaban follows [Google code style](http://google.github.io/styleguide/). The template file, 
+`az-intellij-style.xml`, can be found in the root directory. It's based on the 
+[intellij-java-google-style.xml config file](https://github.com/google/styleguide/blob/75c289f1d33836d1ff4bd94e6c9033673e320b58/intellij-java-google-style.xml) from the google/styleguide project.
 
 Follow [the Intellij's code style help](https://www.jetbrains.com/help/idea/2017.1/code-style.html) 
-to import and set up the style.
- 
-Note: 
-To use different styles for different projects try
- "You can copy the IDE scheme to the current project, using the Copy to Project... command."
+to import and set up the style. Make sure to activate the AzkabanStyle by
+ "copy the IDE scheme to the current project, using the Copy to Project... command."
 
-
-We also recommend 
-intellij's [save actions plugin](https://github.com/dubreuia/intellij-plugin-save-actions) to 
+Install and enable the intellij's [save actions plugin](https://github
+.com/dubreuia/intellij-plugin-save-actions) to 
 reformat/refactor code automatically:
 
 Please turn on all the options except