When contributing to this repository, please first discuss the change you wish to make by submitting an issue of your proposed changes and discuss with the project owners before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
You can contribute by doing any of the following:
- Reporting a bug
- Improving our documentation
- Submitting a fix
- Proposing new features
- Becoming a maintainer
Pull requests are the best way to propose changes to the codebase (we use Github Flow). 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.
- Issue that pull request!
Github's Issues Management
We use GitHub issues to track public bugs as well as feature requests. Report a bug or feature request by opening a new issue and selecting the correct template; it's that easy!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- 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 MIT License.
This document was adapted from the open-source contribution guidelines for Facebook's Draft