Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.08 KB

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
source .venv/bin/activate

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 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                      # runs 'format', 'lint', 'static', and 'unit' environments

Build the charm

Build the charm in this git repository using:

charmcraft pack