We want to make contributing to this project as easy and transparent as possible.
We use GitHub to track issues and feature requests, as well as accept pull requests. See Github Flow for more information about our development process.
We actively welcome your pull requests.
- 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.
We use GitHub issues to track feature requests and public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
Write bug reports with detail, background, and sample code. Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
By contributing, you agree that your contributions will be licensed under its Apache 2.0 license.