Quickstart¶
1 Our repository is at https://github.com/fluffykoalas/sloth.
Development is done on the
dev
branch. Pull Requests should be filed against this branch, not the master branch.Stable releases reside on the
master
branch.
Fork the repository into your own account.
Create a new branch for you patch/feature
Commit as often as you’d like, but:
Make sure the commits are logical and precise before asking for code review. Please see the Commit guidelines section for more info.
Adhere to Our styling guide.
If applicable, provide tests for your code. We aim to have around 99% code coverage in testing.
For new files, add the copyright header. It can be found in the
sloth.__init__
file.Add a changelog entry - see Changelog entries.
Update the documentation - see Updating the documentation.
Squish, squash, rebase and revert commits as asked by reviewers.