Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 2.38 KB

CONTRIBUTING.md

File metadata and controls

46 lines (27 loc) · 2.38 KB

alt text

The Hue project gladly welcomes pull requests!

This document contains instructions on how to help get involved with Hue.

In any case, feel free to ask here, on hue-user or @gethue.

Getting Started

  1. Have a look at how to build Hue.
  2. High level Roadmap. Updating a small piece if documentation is also a quick way to get familiar.
  3. JIRA is the bug tracking system as well as Github issues.

Here are some example of changes:

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 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. Post the patch against the "hue-rw" repository. Enter "hue" in the "groups" field. Example: https://review.cloudera.org/r/4019/

Blog posts about using Code Reviews and the extended process.

Coding Style

A general rule is to follow the on-going style of the code context.

  • Python: Follow Django/PEP8, with the exception of using 2 spaces per indent level.
  • JavaScript: Follow the style in this file.

Tests

See the Running the tests locally or opening-up a pull request will automatically run them via CircleCi.