1
- # Contributing
1
+ # Contributing workflow
2
2
3
3
To make contributions to this charm, you'll need a working [ development setup] ( https://juju.is/docs/sdk/dev-setup ) .
4
4
5
- You can create an environment for development with ` tox ` :
5
+ You can, but not required to, create an environment for development with ` tox ` :
6
6
7
7
``` shell
8
8
tox devenv -e integration
@@ -12,15 +12,16 @@ source venv/bin/activate
12
12
## Testing
13
13
14
14
This project uses ` tox ` for managing test environments. There are some pre-configured environments
15
- that can be used for linting and formatting code when you're preparing contributions to the charm:
15
+ that can be used for linting, formatting and testing code when you're preparing contributions to the charm:
16
16
17
17
``` shell
18
- tox run -e format # update your code according to linting rules
19
- tox run -e lint # code style
20
- tox run -e static # static type checking
21
- tox run -e unit # unit tests
22
- tox run -e integration # integration tests
23
- tox # runs 'format', 'lint', 'static', and 'unit' environments
18
+ tox run -e format # update your code according to linting rules
19
+ tox run -e lint # verify your code according to linting rules
20
+ tox run -e unit # run unit tests
21
+ tox run -e integration-charm # run charm integration test
22
+ tox run -e integration-config # run config integration test
23
+ tox run -e integration-multinode # run multinode integration test
24
+ tox run -e integration-scaling # run scaling integration test
24
25
```
25
26
26
27
## Build the charm
0 commit comments