We release from the main branch by issuing a bump commit including tags noting the version to be released.
This is done via the make release-major, make release-minor and make release-patch followed by git push --follow-tags.
This project depends on Graphviz being installed in your system, follow the instructions here.
We use Poetry to manage this project's dependencies and virtual environment.
Once cloned, just run poetry install to install them. Any time you want to work on this project, just run
poetry shell to activate the virtual environment, and you will be ready.
We use some tools to enforce code formatting. To make sure your code meets these standards, run make fmt (this will
modify the source files automatically) and then make lint to spot potential deficiencies.
Make sure you add tests for any new code contributed to this repo, and make sure you run all the tests with make test
before committing or opening a new pull request.