azkaban-developers

Doc: update the dev guide and README (#1477) - Move IDE setup

9/18/2017 10:43:26 AM

Changes

CONTRIBUTING.md 27(+25 -2)

README.md 6(+1 -5)

Details

CONTRIBUTING.md 27(+25 -2)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index dd230c3..2436ba1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,9 +32,16 @@ Please give your pull request a clear title and description and note which issue
 under [the Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).
 
 
+## IDE setup
+
+We recommend [IntelliJ IDEA](https://www.jetbrains.com/idea/). There is a free community 
+edition available. Azkaban is a standard [Gradle](https://gradle.org/) 
+project. You can import it into your IDE using the `build.gradle` file in the root directory. For IntelliJ, choose Open 
+Project from the Quick Start box or choose Open from the File menu and select the root `build.gradle` file.
+
 ## Style guides
 
-Azkaban follows [Google code style](http://google.github.io/styleguide/). The template file, 
+Azkaban follows the [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.
 
@@ -61,6 +68,16 @@ It allows us to do following when saving a file:
 * Remove unnecessary semicolon
 * Add missing @Override annotations
 
+### todo style
+
+Add your user name to TODO items. 
+
+  Use the form:
+  
+  `
+  todo username: todo details
+  `  
+
 ## Coding conventions
 
 - Automated tests are expected.
@@ -113,8 +130,14 @@ It allows us to do following when saving a file:
   private static final Logger logger = LoggerFactory.getLogger($CLASS_NAME$.class);
   ` 
 
-- Add or update the copyright notice for most files. 
+- Add or update the copyright notice for most files.
+
+- When ignoring a test, provide reasons for ignoring the test.
 
+  Use the form: 
+  
+  `@Ignore("reasons")`
+  
 # Misc
 
 - See [the dev tips wiki](https://github.com/azkaban/azkaban/wiki/Developer-Tools-and-Tips) for 

README.md 6(+1 -5)

diff --git a/README.md b/README.md
index a4436e1..832981e 100644
--- a/README.md
+++ b/README.md
@@ -48,9 +48,5 @@ The source code for the documentation is in the [gh-pages](https://github.com/az
 For help, please visit the [Azkaban Google Group](https://groups.google.com/forum/?fromgroups#!forum/azkaban-dev).
 
 ## Developer Guide
-We recommend using [IntelliJ IDEA](https://www.jetbrains.com/idea/). Azkaban is a standard [Gradle](https://gradle.org/) 
-project. You can import it into your IDE using the `build.gradle` file in the root directory. For IntelliJ, choose Open 
-Project from the Quick Start box or choose Open from the File menu and select the root `build.gradle` file.
 
-See additional information in 
-[the contribution guide](https://github.com/azkaban/azkaban/blob/master/CONTRIBUTING.md).
+See [the contribution guide](https://github.com/azkaban/azkaban/blob/master/CONTRIBUTING.md).