Samuel Allan 6818929c8a
Add docs for the tempest-k8s charm
Change-Id: I7d5538c74bb28e9c9a78235aaec76d23a09c4e40
2024-03-04 10:14:39 +10:30

726 B

Contributing

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

Testing and Development

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. Please see the tox.ini file in the root of this repository.

For example:

# Autoformat the code according to the project's guidelines
tox -e fmt

# Run linters on the code
tox -e pep8

# Run the unit tests with code coverage
tox -e cover -- tempest-k8s

Build the charm

Change to the root of this repository and run:

tox -e build -- tempest-k8s