We love 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
We use github to host code, to track issues and feature requests, as well as accept pull requests.
We use Github Flow.
All code changes happen through pull requests. They are the best way to propose changes to the codebase.
We actively welcome your pull requests:
- Fork the repo and create your branch from
master. - Issue that pull request!
- Review notes from team and update PR accordingly
- Once PR has been approved, the branch is deleted.
- For more info see the Github Flow.
By contributing, you agree that your contributions will be licensed under its MIT License.
Any contributions you make will be under the MIT Software License.
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using Github issues.
We use GitHub issues to track public bugs. Report a bug by opening a new issue. It's super easy!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample command/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)
We love thorough bug reports. I'm not even kidding.
This document was adapted from the open-source contribution guidelines from briandk/CONTRIBUTING.md which was based on Facebook's Draft.