From 7012049098b48933112c7dcd54e1ed5dbd7331c9 Mon Sep 17 00:00:00 2001
From: msramalho <19508417+msramalho@users.noreply.github.com>
Date: Mon, 17 Mar 2025 17:52:13 +0000
Subject: [PATCH] adds pre-commit instructions to the readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index da402e3..079a747 100644
--- a/README.md
+++ b/README.md
@@ -108,6 +108,24 @@ Make sure environment and user-groups files are up to date.
 Then `make prod`.
 
 
+## Development
+```bash
+# make sure all development dependencies are installed
+poetry install --with dev
+
+# this project uses pre-commit to enforce code style and formatting, set that up locally
+poetry run pre-commit install
+
+# you can test pre-commit with
+poetry run pre-commit run --all-files
+
+# this means pre-commit will always run with git commit, to skip it use
+git commit --no-verify
+
+# see the Makefile for more commands, but linting and formatting can be done with
+make lint
+```
+
 ### Testing
 ```bash
 # set the testing environment variables