Together we can create something amazing. Here are some guidelines to follow along the way.
We use github to host code, track issues and feature requests, as well as accept pull requests.
All code changes happen through Github Flow with PUll Requests
Pull requests are the best way to propose changes to the codebase (we use Github Flow).
- 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!
Make sure to look it over and know what it entails. MIT License
Report bugs using Github's issues
Please make sure the bug hasn't been reported and fixed already. Report a bug by opening a new issue; it's that easy!
This is an example of a bug report written by Brian Danielak.
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 of things you tried
By contributing, you agree that your contributions will be licensed under its MIT License.
These guidlines were borrowed from Brian Danielak's guidlines
This document was adapted from the open-source contribution guidelines for Facebook's Draft