If you encounter an issue, start by searching through the list of issues and active pull requests to see if anyone else has raised a similar issue.
If you don't see an issue listed please submit a new issue. Make sure to provide sufficient information on your environment and how to reproduce the issue.
Please sign our Contributor License Agreement (CLA) before sending PRs
- If your contribution is minor, such as a bug fix, open a pull request.
- If your contribution is major, such as a new feature, start by opening an issue first. Others can then weigh in before you commence any work.
- Fork the repo
- Create a local branch for your change, e.g.
git checkout -b my-new-feature-branch - Test your changes
- Commit your changes to local branch, e.g.
git commit -m "feat: my new feature". (see instructions below re: commit message) - Push your changes to remote
git push -u origin my-new-feature-branch - From github, create a PR from your fork to this repo
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons etc)
- refactor: A code change that neither fixes a bug, not adds a feature
- perf: A code change that improves performance
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation