Ver código fonte

HUE-8888 [docs] Simplify contributing guidelines and move them to root

Romain 6 anos atrás
pai
commit
5b2b62eaa2
3 arquivos alterados com 14 adições e 20 exclusões
  1. 11 19
      CONTRIBUTING.md
  2. 1 1
      README.md
  3. 2 0
      tools/docker/hue/README.md

+ 11 - 19
docs/CONTRIBUTING.md → CONTRIBUTING.md

@@ -1,54 +1,46 @@
 ![alt text](https://raw.githubusercontent.com/cloudera/hue/master/docs/images/hue_logo.png "Hue Logo")
 
 
-The Hue project gladly welcomes any patches or [pull requests](https://github.com/cloudera/hue/pulls)!
+The Hue project gladly welcomes [pull requests](https://github.com/cloudera/hue/pulls)!
 
-This document contains instructions on how to get involved with Hue, and our development process.
+This document contains instructions on how to help get involved with Hue.
 
 In any case, feel free to ask here, on [hue-user](http://groups.google.com/a/cloudera.org/group/hue-user) or [@gethue](https://twitter.com/gethue).
 
 # Getting Started
 
-Have a look at [how to build Hue](https://github.com/cloudera/hue#getting-started).
+1. Have a look at [how to build Hue](https://github.com/cloudera/hue#getting-started).
+2. High level [Roadmap](/docs/ROADMAP.md) and list of [Easy bugs](https://issues.cloudera.org/secure/IssueNavigator.jspa?mode=hide&requestId=10431). Updating a small piece if [documentation](https://docs.gethue.com) is also a quick way to get familiar.
+3. [JIRA](https://issues.cloudera.org/browse/HUE) is the bug tracking system as well as [Github issues](https://github.com/cloudera/hue/issues).
 
-## Examples
+Here are some example of changes:
 
 * [Pull request 842](https://github.com/cloudera/hue/pull/842)
 * [HUE-8802 [search] Deleting an index throws a js exception](https://issues.cloudera.org/browse/HUE-8802)
 
-[Roadmap](/docs/ROADMAP.md) and list of [Easy bugs](https://issues.cloudera.org/secure/IssueNavigator.jspa?mode=hide&requestId=10431).
-
-## Bug Tracking
-
-[JIRA](https://issues.cloudera.org/browse/HUE) is the bug tracking system as well as [Github issues](https://github.com/cloudera/hue/issues).
-
 # Submitting an improvement
 
 ## Reviews
 
 It is flexible on how to do code reviews and send patches:
 
-* Github Pull request
-Prefered way. Just post the [pull request](https://github.com/cloudera/hue/pulls) and reviewers will start from there.
-
-* Review Board
+* Github Pull request.
+Prefered way. Just post the [pull request](https://github.com/cloudera/hue/pulls) and reviewers will start from there. The CI will run a bsic set of tests for you.
+* Review Board.
 For large changes. Create an account on Hue's [Review Board](https://review.cloudera.org/groups/hue).
 Post the patch against the "hue-rw" repository. Enter "hue" in the "groups" field.
 Example: [https://review.cloudera.org/r/4019/](https://review.cloudera.org/r/4019/)
 
 Blog posts about using [Code Reviews](http://gethue.com/rbtools-example-how-do-easily-do-code-reviews-with-review-board/) and the [extended process](http://gethue.com/the-hue-team-development-process/).
 
-## Commit
-
-A Hue committer will commit your patch when it is is ready .
 
 ## Coding Style
 
 A general rule is to follow the on-going style of the code context.
 
-* Python: Follow [PEP 8](http://www.python.org/dev/peps/pep-0008/), with the exception of using 2 spaces per indent level. Line width is 100 characters.
+* Python: Follow [Django/PEP8](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/), with the exception of using 2 spaces per indent level.
 * JavaScript: Follow the style in this [file](https://github.com/cloudera/hue/blob/master/apps/oozie/src/oozie/static/oozie/js/bundle-editor.ko.js#L18).
 
 ## Tests
 
-See the [Running the tests](http://cloudera.github.io/hue/latest/developer/development/#testing).
+See the [Running the tests locally](https://docs.gethue.com/latest/developer/development/#testing) or opening-up a pull request will automatically run them via [CircleCi](https://circleci.com/gh/cloudera/hue).

+ 1 - 1
README.md

@@ -56,9 +56,9 @@ configuration is available in the template directory.
 
 Community
 -----------
+   * Contributing [guidelines](CONTRIBUTING.md)
    * Help Forum: https://discourse.gethue.com/ ([previous mailing list](http://groups.google.com/a/cloudera.org/group/hue-user))
    * High level [roadmap](docs/ROADMAP.md)
-   * How to [contribute](docs/CONTRIBUTING.md)
    * Jira: https://issues.cloudera.org/browse/HUE
 
 

+ 2 - 0
tools/docker/hue/README.md

@@ -40,6 +40,8 @@ docker push docker.io/gethue/hue:latest
 
 ## Run the image
 
+Hue can run in one line via the `docker` command (but needs to be configured to point to a real database). To have a zero configuration start use the `docker-compose` section or [kubernetes](tools/kubernetes/) instead.
+
 ### Docker
 
 Directly boot the image: