Repository: incubator-zeppelin Updated Branches: refs/heads/master df1457f5e -> c7645abee
Update the How to contribute to Zeppelin I light update of the `How to contribute to Zeppelin`, including: * Update the link (jira, mailling list, zeppelin) * Add a list of things to do before creating a new PR Author: Anthony Corbacho <[email protected]> Closes #11 from anthonycorbacho/update/contributing and squashes the following commits: 0f756ca [Anthony Corbacho] Update the example of building zeppelin with specific version of spark and hadoop (update version) 829e8b1 [Anthony Corbacho] Fix typo 8cf3413 [Anthony Corbacho] Update the How to contribute to Zeppelin Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/c7645abe Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/c7645abe Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/c7645abe Branch: refs/heads/master Commit: c7645abeefb4f1388c608e166399ec01f5462e3d Parents: df1457f Author: Anthony Corbacho <[email protected]> Authored: Tue Mar 31 10:19:48 2015 +0900 Committer: Lee moon soo <[email protected]> Committed: Thu Apr 2 00:58:38 2015 +0900 ---------------------------------------------------------------------- CONTRIBUTING.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/c7645abe/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72e59f0..3c0ef7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,19 @@ -# IMPORTANT +# How to contribute -**Zeppelin** is [Apache2 License](https://github.com/NFLabs/zeppelin/blob/master/LICENSE) Software. +**Zeppelin** is [Apache2 License](https://github.com/apache/incubator-zeppelin/blob/master/CONTRIBUTING.md) Software. Contributing to Zeppelin (Source code, Documents, Image, Website) means you agree to the Apache2 License. +1. Make sure your issue is not already in the [Jira issue tracker](https://issues.apache.org/jira/browse/ZEPPELIN) +2. If not, create a ticket describing the change you're proposing in the [Jira issue tracker](https://issues.apache.org/jira/browse/ZEPPELIN) +3. Contribute your patch via Pull Request. + + ## Setting up 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/nflabs/zeppelin You'll need git client installed in your development machine. +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) @@ -29,20 +34,20 @@ To build the code, install * Apache Maven ## Getting the source code -First of all, you need the Zeppelin source code. The official location for Zeppelin is [https://github.com/nflabs/zeppelin](https://github.com/nflabs/zeppelin) +First of all, you need the Zeppelin source code. The official location for Zeppelin is [https://github.com/apache/incubator-zeppelin](https://github.com/apache/incubator-zeppelin) ### git access Get the source code on your development machine using git. ``` -git clone https://github.com/NFLabs/zeppelin.git zeppelin +git clone [email protected]: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 https://github.com/NFLabs/zeppelin.git zeppelin +git clone -b branch-0.1 [email protected]:apache/incubator-zeppelin.git zeppelin ``` @@ -66,7 +71,7 @@ mvn install -DskipTests To build with specific spark / hadoop version ``` -mvn install -Dspark.version=1.0.1 -Dhadoop.version=2.2.0 +mvn install -Phadoop-2.2 -Dhadoop.version=2.2.0 -Pspark-1.3 -Dspark.version=1.3.0 ``` ## Run Zepplin server in development mode @@ -86,10 +91,11 @@ bin/zeppelin-daemon start Server will be run on http://localhost:8080 ## JIRA -Zeppelin manages it's issues in Jira. [https://zeppelin-project.atlassian.net/browse/ZEPPELIN](https://zeppelin-project.atlassian.net/browse/ZEPPELIN) +Zeppelin manages it's issues in Jira. [https://issues.apache.org/jira/browse/ZEPPELIN](https://issues.apache.org/jira/browse/ZEPPELIN) ## Stay involved -Contributors should join the Zeppelin mailing lists. +Everyone is welcome to join our mailling list: -* [https://groups.google.com/forum/#!forum/zeppelin-users](https://groups.google.com/forum/#!forum/zeppelin-users) -* [https://groups.google.com/forum/#!forum/zeppelin-developers](https://groups.google.com/forum/#!forum/zeppelin-developers) + * [[email protected]](http://mail-archives.apache.org/mod_mbox/incubator-zeppelin-users/) is for usage questions, help, and announcements [ [subscribe](mailto:[email protected]?subject=send%20this%20email%20to%20subscribe), [unsubscribe](mailto:[email protected]?subject=send%20this%20email%20to%20unsubscribe), [archive](http://mail-archives.apache.org/mod_mbox/incubator-zeppelin-users/) ] + * [[email protected]](http://mail-archives.apache.org/mod_mbox/incubator-zeppelin-users/) is for people who want to contribute code to Zeppelin.[ [subscribe](mailto:[email protected]?subject=send%20this%20email%20to%20subscribe), [unsubscribe](mailto:[email protected]?subject=send%20this%20email%20to%20unsubscribe), [archive](http://mail-archives.apache.org/mod_mbox/incubator-zeppelin-dev/) ] + * [[email protected]](http://mail-archives.apache.org/mod_mbox/incubator-zeppelin-commits/) is for commit messages and patches to Zeppelin. [ [subscribe](mailto:[email protected]?subject=send%20this%20email%20to%20subscribe), [unsubscribe](mailto:[email protected]?subject=send%20this%20email%20to%20unsubscribe), [archive](http://mail-archives.apache.org/mod_mbox/incubator-zeppelin-commits/) ] \ No newline at end of file
