Skip to content

Commit 689ef78

Browse files
committed
Add code checker commands in the readme
Signed-off-by: Gaëtan Lehmann <[email protected]>
1 parent 46ee065 commit 689ef78

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,22 @@ It is automatically executed after every pull request or commit pushed to this r
352352
#### More
353353
Check `./jobs.py --help` and `./jobs.py {command name} --help`.
354354

355+
## Development
356+
357+
This projects uses multiple code checkers to ensure a high quality and coherence of the code.
358+
The checkers are run in the CI on github and will report any failure in the PRs.
359+
360+
To run the checkers locally, you need to install the dev dependencies, and run these commands:
361+
362+
```sh
363+
mypy --install-types --non-interactive lib/ conftest.py pkgfixtures.py tests/
364+
pyright lib/ conftest.py pkgfixtures.py
365+
ruff check lib/ tests/
366+
flake8
367+
```
368+
369+
The code checker diagnostics can also be shown directly in your IDE or text editor.
370+
355371
## VM setup
356372
Many tests expect VMs with:
357373
* OpenSSH server installed and accepting pubkey authentication for the `root` user

0 commit comments

Comments
 (0)