|
|
@@ -11,23 +11,10 @@ In any case, feel free to ask here, on the [forum](https://discourse.gethue.com/
|
|
|
|
|
|
Here is some inspiration on which areas would love to have some contributions:
|
|
|
|
|
|
-1. Updating a small piece of [documentation](https://docs.gethue.com).
|
|
|
-2. High level [Roadmap](/docs/ROADMAP.md).
|
|
|
-3. [JIRA](https://issues.cloudera.org/browse/HUE) is the bug tracking system as well as [Github issues](https://github.com/cloudera/hue/issues).
|
|
|
-4. Generally, improving or creating connectors should be the best projects:
|
|
|
-* SQL (Tip: read (how to write a parser)[link]
|
|
|
- * Hive LLAP
|
|
|
- * Parser for [Apache Calcite](https://calcite.apache.org)
|
|
|
- * Parser for PartiQl
|
|
|
- * Parser for ZetaSql
|
|
|
- * SqlAlchemy (any improvements to connectors for Druid, Phoenix...)
|
|
|
- * Sql streams (Kafka SQL, Flink SQL...)
|
|
|
- * Elastic Search, [Solr](http://gethue.com/sql-editor-for-solr-sql/)
|
|
|
-* Storage: Google Storage
|
|
|
-* Query Optimization
|
|
|
-* Data Catalog
|
|
|
-* Document Sharing (Slack, email...)
|
|
|
-* Result Sharing (Google Spreadsheet, Slack...)
|
|
|
+1. Updating a small piece of [documentation](https://docs.gethue.com)
|
|
|
+2. High level [Roadmap](/docs/ROADMAP.md)
|
|
|
+3. Check [Github issues](https://github.com/cloudera/hue/issues) or [the bug tracking system](https://issues.cloudera.org/browse/HUE)
|
|
|
+4. Improving or creating SQL [autocompletes](https://docs.gethue.com/developer/parsers/) or [connectors](https://docs.gethue.com/developer/sdk/) are great projects
|
|
|
|
|
|
# Submitting an improvement
|
|
|
|
|
|
@@ -38,28 +25,26 @@ Here are some example of changes:
|
|
|
|
|
|
## Building
|
|
|
|
|
|
-Have a look at [how to build Hue](https://github.com/cloudera/hue#getting-started).
|
|
|
+Have a look at [how to quick build](https://docs.gethue.com/developer/development/#build-start).
|
|
|
|
|
|
## Reviews
|
|
|
|
|
|
-It is flexible on how to do code reviews and send patches:
|
|
|
+It is flexible:
|
|
|
|
|
|
-* Github Pull request.
|
|
|
+* **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.
|
|
|
+
|
|
|
+* **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/).
|
|
|
-
|
|
|
+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/).
|
|
|
|
|
|
## Coding Style
|
|
|
|
|
|
A general rule is to follow the on-going style of the code context.
|
|
|
|
|
|
-* 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).
|
|
|
+* 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: Check the [EsLint](https://github.com/cloudera/hue/blob/master/.eslintrc.js) style
|
|
|
|
|
|
## CI & Tests
|
|
|
|