Contributing

Contributions are very welcome!

Tooling

Docker, docker-compose and some python tooling is used in development and testing, because that's what I know best :)

All commands you'll need during dev are only available from within the ./tests directory.

cd ./tests

make build

make tests

For formatting and linting the python tests, following tools are used:

For automatically generating release notes, commit messages are parsed. This only works, if they follow the Conventional Commits specification.

Pre commit hooks is an additional option instead of linting and formatting checks in your editor of choice.

First create a virtualenv with the tool of your choice before running below commands:

pip install pre-commit
pip install -r requirements.txt
pre-commit install --hook=pre-commit
pre-commit install --hook=commit-msg

Make sure python-semantic-release is installed and then run

make release-notes