Getting setup

The quickest way to get the project setup for development is to use virtualenvwrapper and then:

$ mkvirtualenv gocd
$ make develop

This will install all dependencies and setup a git hook that'll ensure you can't push unless you're compliant with PEP8.

Style

This project aims to follow the Google Python Style Guide and particularly the section on commenting the code.

This project follows [PEP8] and uses [flake8] to check the code for violations. There's also a linter in place for ReStructured Text files.

To run the linting do:

$ make lint

Follow Tim Pope's style on how to write good commit messages.

Update CHANGELOG.rst with the changes going in
Run linting (make lint)
Update the version number according to semver. ($ bumpversion <major|minor|patch>)
Push the branch and the tag (git push && git push --tags)
Add a release on GitHub and set the entries from the changelog in the release.
After successfully building click the "Release to Pypi" stage on Snap