We welcome your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
If you haven't already, please read our code of conduct
We use github to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow to ensure all changes go through pull requests and are reviewed by the maintainers.
Please use the following steps:
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
When you submit code changes, your submissions are understood to be under the same Apache 2.0 License that covers the project.
We use GitHub issues to track public bugs. Report a bug by opening a new issue, but please check to see if this issue has already been reported.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code and data if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or things you tried that didn't work)