How to Contribute

To begin with, you should install Higgs. See the Quickstart page for installation instructions. Simply trying Higgs and giving us your feedback about what you like, and especially what you dislike, is useful and appreciated.

Reporting and Fixing Bugs

If you've found a bug in Higgs, either open a new issue and tag it with the "bug" tag, or write a regression test (a failing test exposing the bug) and send us a pull request containing the failing test. Try to fit the entire test in one JS file, and try to come up with the smallest possible piece of code that exposes the bug. The JS file containing the failing test should be added under the source/tests directory of the repository. You may take a stab at trying to fix the bug yourself if you feel inclined to do so. If you think you've found the probable cause or have some suspicion of it, explain your findings in the issue page.

Contributing New Features

If you want to contribute features to Higgs, take a look at the open issues to see if there's a task you might be able to complete or help complete. If more information is needed on the nature of an open issue, please post questions on the page specific to that issues. We'll gladly provide all the details we can.

Ideally, before you begin work on a new feature for Higgs, you should signify your interest, either by contacting us directly or simply by posting on the issues page. This is to ensure that there aren't multiple people working on fixing the same issue. To familiarize yourself with the Higgs source, you may want to read the Code Organization page. You should also take a look at the Code Style Guide before you begin to write code to be included in Higgs.

Once your new contribution is ready, send us a pull request. As with bug fixes, we encourage you to include tests verifying that your code produces the correct behavior and continues to do so should someone modify it in the future.