Unverified Commit f8217c9d authored by karp's avatar karp
Browse files

Update README.md

Explain how to format and type check.
parent b820a149
Loading
Loading
Loading
Loading
Loading
+11 −0
Original line number Diff line number Diff line
@@ -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