Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.
For major changes, please open an issue first describing what you want to add/change.
- Fork the project
- Create a new branch
- Code, test, commit and push
- Open a pull request detailing your changes
- Please ensure the coding style running
make lint
. - Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
- You may need to rebase to avoid merge conflicts.
- Please remember that we follow SemVer.
Clone your fork, then install the dev dependencies:
make install
Lint your code:
make lint
Run all tests:
make test