Repository: incubator-zeppelin Updated Branches: refs/heads/master b22fe2fa8 -> cc3b8c049
Add/pr teamplate ### What is this PR for? This PR has for goal to set guidelines regarding the **Pull Request** format in order to simplify the reviewer job. It updates the project guidelines to include the template, and provides an easy click to fill Pull Request tool. _This PR itself is done using the Pull Request's format_ ### What type of PR is it? Documentation ### Todos * [x] - Include PR Template in the Project Guidelines * [x] - Small modifications to the project guidelines * [x] - Add short bookmarklet to the project guidelines ### Is there a relevant Jira issue? No ### How should this be tested? * You can check this PR's Markdown files for the documentation * You can try the bookmarklet by creating a new bookmarked page and copy/pasting the code as its content, then click on it while creating a PR. ### Screenshots (if appropriate) The template's bookmarklet in action:  ### Questions: * Does the licenses files need update? **No** * Is there breaking changes for older versions? **No** * Does this needs documentation? **No, it is documentation** Author: Damien CORNEAU <[email protected]> Closes #523 from corneadoug/add/PRTeamplate and squashes the following commits: f44cb20 [Damien CORNEAU] Have bookmarklet has one line block in markdown de89581 [Damien CORNEAU] Fix bookmarklet 3e08747 [Damien CORNEAU] Modify Zeppelin-web contribution guidelines 6242059 [Damien CORNEAU] Add link to WebApplication contribution Guidelines 40ca5d1 [Damien CORNEAU] Fix Source Control Workflow Link ebab2b3 [Damien CORNEAU] Add the PR template to documentation 6072551 [Damien CORNEAU] Add issue tracker to README Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/cc3b8c04 Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/cc3b8c04 Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/cc3b8c04 Branch: refs/heads/master Commit: cc3b8c049f2791b97141d8e5ee980db455ef520b Parents: b22fe2f Author: Damien CORNEAU <[email protected]> Authored: Wed Dec 9 16:58:43 2015 +0900 Committer: Damien CORNEAU <[email protected]> Committed: Fri Dec 11 14:15:48 2015 +0900 ---------------------------------------------------------------------- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++-- README.md | 3 ++- zeppelin-web/CONTRIBUTING.md | 15 ++++++++++++--- zeppelin-web/README.md | 2 +- 4 files changed, 50 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/cc3b8c04/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aecfca0..c53e35e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,10 +7,40 @@ Contributing to Zeppelin (Source code, Documents, Image, Website) means you agre 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. +## Creating a Pull Request +In order to make the review process easier, please follow this template when making a Pull Request: -## Source Control Workflow -Zeppelin follows [Fork & Pull] (https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git: -Fork, -Branching, -Commits, -and-Pull-Request) model. +``` +### What is this PR for? +A few sentences describing the overall goals of the pull request's commits. + +### What type of PR is it? +[Bug Fix | Improvement | Feature | Documentation | Hot Fix | Refactoring] + +### Todos +* [ ] - Task + +### Is there a relevant Jira issue? + +### How should this be tested? +Outline the steps to test the PR here. + +### Screenshots (if appropriate) +### Questions: +* Does the licenses files need update? +* Is there breaking changes for older versions? +* Does this needs documentation? +``` + +You can also use this small bookmarklet tool to fill your Pull Request fields automatically: + +``` +javascript:(function() {var e = document.getElementById('pull_request_body');if (e) {e.value += '### What is this PR for?\nA few sentences describing the overall goals of the pull request\'s commits.\n\n### What type of PR is it?\n[Bug Fix | Improvement | Feature | Documentation | Hot Fix | Refactoring]\n\n### Todos\n* [ ] - Task\n\n### Is there a relevant Jira issue?\n\n### How should this be tested?\nOutline the steps to test the PR here.\n\n### Screenshots (if appropriate)\n\n### Questions:\n* Does the licenses files need update?\n* Is there breaking changes for older versions?\n* Does this needs documentation?';}})(); +``` + +## Source Control Workflow +Zeppelin follows [Fork & Pull] (https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request) model. ## The Review Process @@ -65,6 +95,9 @@ The top-level pom.xml describes the basic project structure. Currently Zeppelin <module>zeppelin-server</module> <module>zeppelin-distribution</module> +### Web Project Contribution Guidelines +If you plan on making a contribution to Zeppelin's WebApplication, +please check [its own contribution guidelines](https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-web/CONTRIBUTING.md) ### Code convention We are following Google Code style: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/cc3b8c04/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index bd2a04c..85fc0b6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ #Zeppelin **Documentation:** [User Guide](http://zeppelin.incubator.apache.org/docs/index.html)<br/> -**Mailing List:** [User and Dev mailing list](http://zeppelin.incubator.apache.org/community.html)<br/> +**Mailing Lists:** [User and Dev mailing list](http://zeppelin.incubator.apache.org/community.html)<br/> **Continuous Integration:** [](https://travis-ci.org/apache/incubator-zeppelin) <br/> **Contributing:** [Contribution Guide](https://github.com/apache/incubator-zeppelin/blob/master/CONTRIBUTING.md)<br/> +**Issue Tracker:** [Jira](https://issues.apache.org/jira/browse/ZEPPELIN)<br/> **License:** [Apache 2.0](https://github.com/apache/incubator-zeppelin/blob/master/LICENSE) http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/cc3b8c04/zeppelin-web/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/zeppelin-web/CONTRIBUTING.md b/zeppelin-web/CONTRIBUTING.md index 6873b0f..67bd89f 100644 --- a/zeppelin-web/CONTRIBUTING.md +++ b/zeppelin-web/CONTRIBUTING.md @@ -1,4 +1,11 @@ # Contributing to Zeppelin-Web + +## Dev Mode +When working on Zeppelin's WebApplication, it is recommended to run in dev mode. + +For that, start Zeppelin server normally, then use ``./grunt serve`` in _zeppelin-web_ directory. + +This will launch a Zeppelin WebApplication on port **9000** that will update on code changes. ## Technologies @@ -16,8 +23,10 @@ So you might want to get familiar with it. But don't worry, JSHint will make you remember it for the most part. -There is also a rule of **No JQuery except in directives**, If you want to include a library, -please search for its **angularJS** directive first and if it doesn't exist, make one :) +We try not to have **JQuery except in directives**, If you want to include a library, +please search for its **angularJS** directive first. + +If you still need to use it, then please use ``angular.element()`` instead of ``$()`` ## Folder Structure & Code Organization @@ -94,7 +103,7 @@ The `components` folder is here to contains any reusable component (used more th Fonts files and their css are mixed together in the `fonts` folder -## Compiling and using dev mode +## New files includes As we do not use yeoman to generate controllers or other type of files with this new structure, we need to do some includes manually in `index.html` in order to use dev mode and compile correctly. http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/cc3b8c04/zeppelin-web/README.md ---------------------------------------------------------------------- diff --git a/zeppelin-web/README.md b/zeppelin-web/README.md index cbd7d73..92a0131 100644 --- a/zeppelin-web/README.md +++ b/zeppelin-web/README.md @@ -24,7 +24,7 @@ Here are the basic commands to compile the WebApplication with a configured envi ``./grunt serve`` -This will launch a Zeppelin WebApplication on port **9000** and update on code changes. +This will launch a Zeppelin WebApplication on port **9000** that will update on code changes. (You will need to have Zeppelin running on the side)
