charm-magnum-k8s/CONTRIBUTING.md
Guillaume Boutry 8c03b452ba
Initial commit
2023-08-24 11:15:01 +02:00

984 B

Contributing

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

You can create an environment for development with tox:

tox devenv -e integration
source venv/bin/activate

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:

charmcraft pack