Skip to content

Commit d225c4c

Browse files
committed
Documentation.
1 parent e2fa39f commit d225c4c

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Contributing
1+
# Contributing workflow
22

33
To make contributions to this charm, you'll need a working [development setup](https://juju.is/docs/sdk/dev-setup).
44

5-
You can create an environment for development with `tox`:
5+
You can, but not required to, create an environment for development with `tox`:
66

77
```shell
88
tox devenv -e integration
@@ -12,15 +12,16 @@ source venv/bin/activate
1212
## Testing
1313

1414
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:
1616

1717
```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
2425
```
2526

2627
## Build the charm

0 commit comments

Comments
 (0)