Community

Contributing to Heron

Community is a critical factor to the success of Heron. Contributions are welcome! After reviewing the Heron Architecture, Compiling Heron, and the Heron Codebase, this page covers how to contribute and, when you’ve made a patch, how to submit it.

How Can I Contribute to Heron?

In general, contributions that fix bugs or add features (as opposed to stylistic, refactoring, or “cleanup” changes) are preferred. If you’re looking for places to contribute, issues labeled help-wanted are good candidates. Please check the dev list before investing a lot of time in a patch.

Continue to Heron Architecture, Compiling Heron, or Heron Codebase.

Setting up IDEA

Heron includes a script to bootstrap an IntelliJ IDEA project. The project includes support for Heron code styles and copyright headers. To bootstrap an IDEA project run the following:

$ ./scripts/setup-intellij.sh

Submitting a Patch

  1. Read the Heron governance plan and accept the Twitter Contributor License Agreement (CLA).

  2. Discuss your plan and design, and get agreement on our heron-dev@googlegroups.com mailing list.

  3. Implement the change with unit tests and verify that all tests pass.

  4. Submit a GitHub pull request that implements the feature. Clearly describe the the change in the description. Verify that Travis CI passes.

  5. Complete a code review by addressing comments of the reviewers.

  6. A project committer will merge the patch to the master branch.

Next: Review the Heron Codebase