As a guideline, please follow this process when contributing:
- Fork the repository.
- Create a branch from master (
git checkout -b branch-name master). - Make the relevant code changes.
- If your change will require documentation updates, include them in the same pull request.
- Use the various quality checks provided:
- Run the tests with
make test. - Generate a coverage report with
make coverage, then open it withmake open-coverage. - Fix code style issues with
make lint, but be sure to stage changes first.
- Run the tests with
- Squash commits if necessary (
git rebase -i master). - Submit a pull request to the master branch.