CONTRIBUTING.md

Contributing

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

You can use the environments created by tox for development:

tox --notest -e unit
source .tox/unit/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 -e lint          # code style
tox -e static        # static analysis
tox -e unit          # unit tests
tox -e integration   # integration tests

Build

Building charms is done using charmcraft (official documentation here). You can install charmcraft using snap:

sudo snap install charmcraft --channel=classic

Initialize LXD:

lxd init --auto

Go to the charm directory and run:

charmcraft pack