In order to contribute to this project, please:
- Ensure that you have set your
git config --global user.nameandgit config --global user.emailbefore committing - Always use feature branches for anything you contribute (i.e. you shouldn't work on the
masterbranch of your own fork) - Always write proper commit messages (also featured in the Git book)
- Always work in your fork
- Follow the GitHub flow
- Use atomic commits
- Also follow this with your PRs: if two things are not related they should preferably not be in the same PR so that their reviews can happen in parallel and one doesn't block the other.
When contributing code (rather than e.g. documentation):
- Make sure that your code builds
- Make sure to add test coverage (where reasonably possible)
- Make sure that it's properly documented (where applicable)
If you're new to Git, GitHub and all of this, these links might help you:
- Git (official page with downloads, more links, etc.)
- Official Git Book
- GitHub Quickstart
- GitHub's Git Guide
- GitHub's Git Cheat Sheet
- Official Git Reference Manual
- Usually you'll instead get here by just typing
git helporgit help [command]rather than searching on the page
- Usually you'll instead get here by just typing