Forráskód Böngészése

HUE-8815 [docs] Refresh and simplify the contribution guidelines

Romain 6 éve
szülő
commit
05a91bde27
1 módosított fájl, 18 hozzáadás és 40 törlés
  1. 18 40
      docs/CONTRIBUTING.md

+ 18 - 40
docs/CONTRIBUTING.md

@@ -3,50 +3,44 @@
 
 The Hue project gladly welcomes any patches or [pull requests](https://github.com/cloudera/hue/pulls)!
 
-This document contains instructions on how to get involved with Hue, and our development process. The team also follows this [logic](http://gethue.com/the-hue-team-development-process/).
+This document contains instructions on how to get involved with Hue, and our development process.
 
-In any case, feel free to ask on [hue-user](http://groups.google.com/a/cloudera.org/group/hue-user), here or [@gethue](https://twitter.com/gethue).
+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).
 
-## Example of bug, patch and review
+## Examples
 
-* [List of pull requests](https://github.com/cloudera/hue/pulls)
-* [HUE-2617 [metastore] Return partition results in reverse order by default](https://issues.cloudera.org/browse/HUE-2617)
+* [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)
 
-List of [Easy bugs](https://issues.cloudera.org/secure/IssueNavigator.jspa?mode=hide&requestId=10431).
+[Roadmap](/docs/ROADMAP.md) and list of [Easy bugs](https://issues.cloudera.org/secure/IssueNavigator.jspa?mode=hide&requestId=10431).
 
 ## Bug Tracking
 
-Hue uses [JIRA](https://issues.cloudera.org/browse/HUE) as its bug tracking system.
+[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
+# Submitting an improvement
 
-### Reviews
+## Reviews
 
-Hue blog posts about using Review Board: [How to do Code Reviews](http://gethue.com/rbtools-example-how-do-easily-do-code-reviews-with-review-board/).
+It is flexible on how to do code reviews and send patches:
 
-Currently, the Hue project is very flexible on how to do code reviews:
+* Github Pull request
+Prefered way. Just post the [pull request](https://github.com/cloudera/hue/pulls) and reviewers will start from there.
 
 * Review Board
-Create an account on Hus's [Review Board](https://review.cloudera.org/groups/hue).
+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/)
 
-* Github Diff or Pull request
-Again, for small changes, if you have the fix in a commit in your own github fork, you can just post the [pull request](https://github.com/cloudera/hue/pulls)
+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/).
 
-* JIRA Attachment
-For small changes, you can attach the patch in the JIRA.
-
-### Commit
-
-A Hue committer will commit your patch when it is is ready after being reviewed.
-
-Example of [commit](https://github.com/cloudera/hue/commit/968d58c72119e4055bb081ba023e02b8ac8534dd).
+## Commit
 
+A Hue committer will commit your patch when it is is ready .
 
 ## Coding Style
 
@@ -55,22 +49,6 @@ 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.
 * 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
 
-### Tests
-
-Please run the tests. Se the [Getting started](https://github.com/cloudera/hue#getting-started) then [testing](http://cloudera.github.io/hue/latest/sdk/sdk.html#testing).
-
-### Patch Format
-
-Generate the patch using @git format-patch@ with a message looking like:
-
-<pre>
-HUE-NNNN [APP_NAME] The JIRA summary line
-
-Optional details on the commit *after* a blank line.
-This section can span multiple lines.
-
-Or have multiple paragraphs.
-</pre>
-
-Example of [format](https://github.com/cloudera/hue/commit/ab09a825f71ae9817f07befc520a4d0bd85f88f0).
+See the [Running the tests](http://cloudera.github.io/hue/latest/developer/development/#testing).