Skip to content
This repository was archived by the owner on Aug 19, 2022. It is now read-only.

Latest commit

 

History

History
24 lines (18 loc) · 739 Bytes

CONTRIBUTOR.md

File metadata and controls

24 lines (18 loc) · 739 Bytes

Contribution Guide

Running Locally

To speed up development cycles you can run tests and linting locally with:

docker-compose run --rm app lint
docker-compose run --rm app test

This will mount your local working directory into the container and set it as the working directory within the container.

To exactly replicate the CI steps, add the -f docker-compose.ci.yml arg to the above commands.

Publishing A New Version

To cut a new version, follow these steps:

  • create and merge final feature branch updating CHANGELOG.md
  • tag final commit hash with git tag <VERSION>, e.g. git tag 0.1.3.
  • publish to pypi with:
docker-compose run --rm app bash publish.sh
  • push tag to github with git push --tags