From 9e0cbaedb7bb21c51f23cb461e241d779c04c9ae Mon Sep 17 00:00:00 2001
From: Leander Karp <karp@cl.uni-heidelberg.de>
Date: Mon, 9 Sep 2024 18:52:43 +0200
Subject: [PATCH] Update README.md

Explain how to format and type check.

(cherry picked from commit f8217c9d72b081b1dd000155d6a99e84681c0113)
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 6717fb3..bfbb32b 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
-- 
GitLab