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
- Fork this repository
- Clone the repository to your local machine
- Make necessary changes
- Commit the changes and add a branch pointing to this repository.
- Make a PR mentioning all the changes.
- If your PR makes a significant improvement and changes to the project without causing any break points the PR will be merged without any failure.
Any contributions you make will be under the Creative Commons Attribution-NonCommercial 4.0 International License.
In short, when you submit code changes, your submissions are understood to be under the same Creative Commons Attribution-NonCommercial 4.0 International License. that covers the project. Feel free to contact the maintainers if that's a concern.
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 Creative Commons Attribution-NonCommercial 4.0 International License.
This document was adapted from the open-source contribution guidelines for Facebook's Draft