We want to make contributing to this project as easy as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
Pull requests are the best way to propose changes to the codebase.
Steps:
- Fork the repo and create your branch from
master. - If you've changed APIs, update the documentation.
- Make sure your code lints.
- Issue that pull request!
We use GitHub issues to track bugs. Report a bug by opening a new issue.
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)
- As long as there is some attempt at consistency we should be fine.
By contributing, you agree that your contributions will be licensed under the MIT License.