diff --git a/contribution/contributions.md b/contribution/contributions.md index 70831357a..4421841dd 100644 --- a/contribution/contributions.md +++ b/contribution/contributions.md @@ -21,7 +21,7 @@ limitations under the License. # Contribution Guidelines -**Apache Zeppelin** is an [Apache2 License](https://github.com/apache/zeppelin/blob/master/CONTRIBUTING.md) Software. +**Apache Zeppelin** is an [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0) Software. Contributing to Zeppelin (Source code, Documents, Image, Website) means you agree to the Apache2 License. @@ -127,19 +127,45 @@ You are free to use whatever IDE you prefer, or your favorite command line edito Zeppelin project is based on Maven. Maven works by convention & defines [directory structure] (https://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html) for a project. The top-level pom.xml describes the basic project structure. Currently Zeppelin has the following modules. + build-tools + zeppelin-interpreter-parent zeppelin-interpreter + zeppelin-interpreter-shaded zeppelin-zengine + rlang + zeppelin-jupyter-interpreter + zeppelin-jupyter-interpreter-shaded + groovy spark + spark-submit markdown + mongodb angular shell + livy + hbase + jdbc + file flink - ignite - lens + flink-cmd + influxdb + python cassandra - zeppelin-web + elasticsearch + bigquery + alluxio + neo4j + java + sparql + zeppelin-common + zeppelin-client + zeppelin-client-examples + zeppelin-web-angular zeppelin-server + zeppelin-jupyter + zeppelin-plugins zeppelin-distribution + zeppelin-test ### Code convention We are following Google Code style: @@ -147,7 +173,7 @@ We are following Google Code style: * [Java style](https://google.github.io/styleguide/javaguide.html) * [Shell style](https://google.github.io/styleguide/shell.xml) -There are some plugins to format, lint your code in IDE (use [_tools/checkstyle.xml](https://github.com/apache/zeppelin/tree/master/_tools) as rules) +There are some plugins to format, lint your code in IDE (use [checkstyle.xml](https://github.com/apache/zeppelin/blob/master/build-tools/src/main/resources/zeppelin/checkstyle.xml) as rules) * [Checkstyle plugin for Intellij](https://plugins.jetbrains.com/plugin/1065) ([Setting Guide](http://stackoverflow.com/questions/26955766/intellij-idea-checkstyle)) * [Checkstyle plugin for Eclipse](http://eclipse-cs.sourceforge.net/#!/) ([Setting Guide](http://eclipse-cs.sourceforge.net/#!/project-setup)) @@ -191,7 +217,7 @@ If you want not only build Zeppelin but also make change, then you need fork [Ze To build the code, install - * Oracle Java 7 + * Java 11 (JDK 11) * Apache Maven ### Building the code