CONTRIBUTING.md

Contributing

To make contributions to this charm, you'll need a working development setup.

Developing

Install tox and poetry

python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install tox
pipx install poetry

You can create an environment for development:

poetry install

Testing

This project uses tox for managing test environments. There are some pre-configured environments that can be used for linting and formatting code when you're preparing contributions to the charm:

tox run -e format        # update your code according to linting rules
tox run -e lint          # code style
tox run -e static        # static type checking
tox run -e unit          # unit tests
tox run -e integration   # integration tests
tox                      # runs 'format', 'lint', 'static', and 'unit' environments

Build the charm

Build the charm in this git repository using:

tox run -e build