CONTRIBUTING.md

Contributing

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

This project uses uv. You can install it on Ubuntu with:

sudo snap install --classic astral-uv

You can create an environment for development with uv:

uv sync

Testing

This project uses tox for managing test environments. It can be installed with:

uv tool install tox --with tox-uv

There are some pre-configured environments that can be used for linting and formatting code when you're preparing contributions to the charm:

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

Build the charm

Build the charm in this git repository using:

charmcraft pack