All contributions to this project will be released under the BSD 3-Clause Clear License. . By submitting a pull request or filing a bug, issue, or feature request, you are agreeing to comply with this waiver of copyright interest. You're also agreeing to abide by our Code of Conduct.
There are two primary ways to help:
- Using the issue tracker, and
- Changing the code-base.
Use the issue tracker to suggest feature requests, report bugs, and ask questions. This is also a great way to connect with the developers of the project as well as others who are interested in this solution.
Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in the issue that you will take on that effort, then follow the Changing the code-base guidance below.
Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull request. All new code should have associated unit tests that validate implemented features and the presence or lack of defects. Additionally, the code should follow any stylistic and architectural guidelines prescribed by the project. For us here, this means you install a pre-commit hook and use the given style files. Basically, you should mimic the styles and patterns in the Hamilton code-base.
In terms of getting setup to develop, we invite you to read our developer setup guide.
- Install the circleci CLI.
- To run a circleci job locally, you should then, from the root of the repository, do
circleci local execute --job=JOB_NAME
- This assumes you have docker installed, it will pull the images, but otherwise will run the circleci job.