Interested in contributing? Awesome! There are many ways you can contribute!
- If you find a bug, please search for it in the Issues, and if it isn't already tracked, create a new issue. Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still be reviewed.
- Issues that have already been identified as a bug (note: able to reproduce) will be labelled
bug. - If you'd like to submit a fix for a bug, send a Pull Request] and mention the Issue number.
- Include tests that isolate the bug and verifies that it was fixed.
- If you'd like to add new functionality to this project, describe the problem you want to solve in a new Issue.
If you're new to our project and looking for some way to make your first contribution, look for
Issues labelled good first contribution.
For a contribution to be accepted:
- The test suite must be complete and pass.
- The changes must be approved by code review.
- Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
- Fork the repository on GitHub.
- Clone/fetch your fork to your local development machine. It's a good idea to run the tests just to make sure everything is in order.
- Create a new branch and check it out.
- Make your changes and commit them locally. Magic happens here!
- Push your new branch to your fork. (e.g.
git push username fix-issue-n). - Open a Pull Request on github.com from your new branch on your fork to
masterin this repository.