diff --git a/README.md b/README.md index 9dd644dc1d3b309f83482f8d2d0d43fa2302c1fb..88295a7d4e27878a3368dae5a0994705a340036f 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,17 @@ Alembic must always be up to date in order to update the database schema. 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