Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 816 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (27 loc) · 816 Bytes
Raw

Contributing

  • Fork the repository
  • Clone your fork
git clone https://github.com/USERNAME/cellshape-helper
  • Install an editable version (-e) with the development requirements (dev)
cd cellshape-voxel
pip install -e .[dev]
  • To install pre-commit hooks to ensure formatting is correct:
pre-commit install
  • To release a new version:

Firstly, update the version with bump2version (bump2version patch, bump2version minor or bump2version major). This will increment the package version (to a release candidate - e.g. 0.0.1rc0) and tag the commit. Push this tag to GitHub to run the deployment workflow:

git push --follow-tags

Once the release candidate has been tested, the release version can be created with:

bump2version release