Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

19 lines (15 loc) · 1.18 KB

Contributing

Project uses poetry and invoke to setup development environment. See Poetry documentation how to install Poetry in your operating system. Then use poetry install to install required dependencies.

Test can be run by: poetry run invoke test Bug fix or feature should be covered by tests and test(s) should be places in utest folder. Project uses Python pytest and is recommended to use plain functions in tests.

Commit messages should use Angular style because project uses Python semantic release package and commit message defines the next version number. More details about commit message format can be found from parsing commit logs

Release

Release is done automatically by a GitHub action. Release is triggered automatically with Python semantic release and pushed out to PyPi