You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mo...@apache.org on 2015/08/12 03:14:41 UTC
incubator-zeppelin git commit: Added details on:
Repository: incubator-zeppelin
Updated Branches:
refs/heads/master fd049a452 -> 4509efd27
Added details on:
1. Zeppelin Github workflow
2. Zeppelin project structure
3. Type of Tests
Author: Vinay Shukla <vi...@gmail.com>
Closes #194 from vinayshukla/ImproveContributingPage and squashes the following commits:
bfed0d0 [Vinay Shukla] Added details on: 1. Zeppelin Github workflow 2. Zeppelin project structure 3. Type of Tests
Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/4509efd2
Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/4509efd2
Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/4509efd2
Branch: refs/heads/master
Commit: 4509efd27c43958d591209f5f83a42c3b2be62fd
Parents: fd049a4
Author: Vinay Shukla <vi...@gmail.com>
Authored: Sun Aug 9 10:38:13 2015 -0700
Committer: Lee moon soo <mo...@apache.org>
Committed: Tue Aug 11 18:14:37 2015 -0700
----------------------------------------------------------------------
CONTRIBUTING.md | 44 +++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 43 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/4509efd2/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3c0ef7d..aa69016 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,6 +8,9 @@ Contributing to Zeppelin (Source code, Documents, Image, Website) means you agre
3. Contribute your patch via Pull Request.
+## SourceControl Workflow
+Zeppelin follows [Fork & Pull] (https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request) model.
+
## Setting up
Here are some things you will need to build and test Zeppelin.
@@ -17,7 +20,29 @@ Zeppelin uses Git for it's SCM system. Hosted by github.com. `https://github.com
### Integrated Development Environment(IDE)
-You are free to use whatever IDE you prefer, or your favorite command line editor.
+You are free to use whatever IDE you prefer, or your favorite command line editor.
+
+### Project Structure
+
+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>
+
### Code convention
We are following Google Code style:
@@ -74,6 +99,23 @@ 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
```
+## Tests
+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:
+
+ 1. Unit Tests: The unit tests run as part of each package's build. E.g SparkInterpeter Module's unit test is SparkInterpreterTest
+ 2. 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.
+ 3. 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.
+
+## Continuous Integration
+
+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
```