How to contribute
Zeppelin is Apache2 License Software. Contributing to Zeppelin (Source code, Documents, Image, Website) means you agree to the Apache2 License.
- Make sure your issue is not already in the Jira issue tracker
- If not, create a ticket describing the change you’re proposing in the Jira issue tracker
- Contribute your patch via Pull Request.
Zeppelin follows [Fork & Pull] (https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request) model.
Here are some things you will need to build and test Zeppelin.
Software Configuration Management(SCM)
Zeppelin uses Git for it’s SCM system. Hosted by github.com.
https://github.com/apache/incubator-zeppelin You’ll need git client installed in your development machine.
Integrated Development Environment(IDE)
You are free to use whatever IDE you prefer, or your favorite command line editor.
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.
<module>zeppelin-interpreter</module> <module>zeppelin-zengine</module> <module>spark</module> <module>markdown</module> <module>angular</module> <module>shell</module> <module>hive</module> <module>tajo</module> <module>flink</module> <module>ignite</module> <module>lens</module> <module>cassandra</module> <module>zeppelin-web</module> <module>zeppelin-server</module> <module>zeppelin-distribution</module>
We are following Google Code style:
Checkstyle report location are in
Test coverage report location are in
To build the code, install
- Oracle Java 7
- Apache Maven
Getting the source code
First of all, you need the Zeppelin source code. The official location for Zeppelin is https://github.com/apache/incubator-zeppelin
Get the source code on your development machine using git.
git clone email@example.com:apache/incubator-zeppelin.git zeppelin
You may also want to develop against a specific release. For example, for branch-0.1
git clone -b branch-0.1 firstname.lastname@example.org:apache/incubator-zeppelin.git zeppelin
If you want not only build Zeppelin but also make change, then you need fork Zeppelin repository and make pull request.
To skip test
mvn install -DskipTests
To build with specific spark / hadoop version
mvn install -Phadoop-2.2 -Dhadoop.version=2.2.0 -Pspark-1.3 -Dspark.version=1.3.0
Each new File should have its own accompanying unit tests. Each new interpreter should have come with its tests.
Zeppelin has 3 types of tests:
- Unit Tests: The unit tests run as part of each package’s build. E.g SparkInterpeter Module’s unit test is SparkInterpreterTest
- Integration Tests: The intergration tests run after all modules are build. The integration tests launch an instance of Zeppelin server. ZeppelinRestApiTest is an example integration test.
- GUI integration tests: These tests validate the Zeppelin UI elements. These tests require a running Zepplein server and lauches a web browser to validate Notebook UI elements like Notes and their execution. See ZeppelinIT as an example.
Currently the GUI integration tests are not run in the Maven and are only run in the CI environment when the pull request is submitted to github. Make sure to watch the [CI results] (https://travis-ci.org/apache/incubator-zeppelin/pull_requests) for your pull request.
Zeppelin uses Travis for CI. In the project root there is .travis.yml that configures CI and [publishes CI results] (https://travis-ci.org/apache/incubator-zeppelin/builds)
Run Zepplin server in development mode
cd zeppelin-server HADOOP_HOME=YOUR_HADOOP_HOME JAVA_HOME=YOUR_JAVA_HOME mvn exec:java -Dexec.mainClass="com.nflabs.zeppelin.server.ZeppelinServer" -Dexec.args=""
or use daemon script
Server will be run on http://localhost:8080
Zeppelin manages it’s issues in Jira. https://issues.apache.org/jira/browse/ZEPPELIN
Everyone is welcome to join our mailling list:
- email@example.com is for usage questions, help, and announcements [ subscribe, unsubscribe, archive ]
- firstname.lastname@example.org is for people who want to contribute code to Zeppelin.[ subscribe, unsubscribe, archive ]
- email@example.com is for commit messages and patches to Zeppelin. [ subscribe, unsubscribe, archive ]