diff --git a/README.md b/README.md index 6717fb317f49e2e8316f240c8f180409ae16833f..bfbb32bcfa11c060b7c868d59ff592ef01458164 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,17 @@ Please run `alembic upgrade head` after pulling changes from the repository. --- +## Compliance + +### Formatting + +We use [black](https://github.com/psf/black) as formatting tool. +Use `black .` to run the formatter. + +### Static Type Checking + +Run `mypy .` to let [mypy](https://www.mypy-lang.org/) validate the Python types. + ## How to move around in this repo ## `/portal/`: Main Application