366c0ef259
This commit adds masakari-k8s to Sunbeam along with basic unit tests. The application is deployable in its current form though changes may be needed as consul and OS hypervisor development progresses. Note the temporarily disabled entries in charmcraft.yaml for consul and host-monitor. func-test-pr: https://github.com/openstack-charmers/zaza-openstack-tests/pull/1271 Change-Id: I637e777f216201b3c64043ddcfed464518f5191f
31 lines
870 B
Markdown
31 lines
870 B
Markdown
# Contributing
|
|
|
|
To make contributions to this charm, you'll need a working [development setup](https://juju.is/docs/sdk/dev-setup).
|
|
|
|
You can create an environment for development with `tox`:
|
|
|
|
```shell
|
|
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:
|
|
|
|
```shell
|
|
tox run -e fmt # update your code according to linting rules
|
|
tox run -e pep8 # code style
|
|
tox run -e linters # static type checking
|
|
tox run -e py3 # unit tests
|
|
tox # runs 'format', 'lint', 'static', and 'unit' environments
|
|
```
|
|
|
|
## Build the charm
|
|
|
|
Build the charm in this git repository using:
|
|
|
|
```shell
|
|
tox run -e build masakari-k8s
|
|
``` |