First off, thanks for taking the time to contribute!
Please read through our Installation Instructions.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the core team before making a change.
- Make sure you have a GitHub account.
- Submit a GitHub issue for your issue if one does not already exist.
- A issue is not necessary for trivial changes.
- Fork the repository on GitHub.
- Configuring a remote for a fork
- Syncing a fork
git fetch upstreamgit checkout mastergit merge upstream/master
- Merging an upstream repository into your fork
git checkout mastergit pull upstream master- Commit the merge
git push origin master
- When working on an issue, create a new branch from
masternamed for issue number or custom name. Name the branchissue/<issue-number>orissue/<custom-name>. For exampleissue/22for fixing issue #22. - Make your changes.
- Follow the Style Guides.
- Avoid platform-dependent code.
- Add tests if your changes contains new, testable behavior.
- Make the tests pass.
- Create a pull request to the repository.
pre-commit is configured for this repo, which you may optionally use to ease the steps involved in submitting your changes.
First install the pre-commit package manager using the appropriate method,
then run bin/install-hooks and now pre-commit will run automatically on each git commit:
$ bin/install-hooks
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/commit-msgmainis the latest, deployed version.