From 0647a039b020b050e3e028614adbeceb86222bec Mon Sep 17 00:00:00 2001
From: Joel Collins <joel@jtcollins.net>
Date: Thu, 12 Nov 2020 14:35:17 +0000
Subject: [PATCH] Added note on pre-commit

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

diff --git a/README.md b/README.md
index e3327bce..670dd7d0 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,17 @@ This includes installing the server in a mode better suited for active developme
 * `poetry install`
 * `poetry run build_static`
 
+### Pre-commit hooks
+
+We make use of pre-commit hooks to run code analysis before committing to the codebase.
+
+The simplest way to ensure this works is to install pre-commits into your global Python environment:
+
+* `pip3 install pre-commit`
+* `pre-commit install`
+
+Alternatively, you can work within the Poetry project's virtual environment where pre-commit will already be installed as a developer dependency.
+
 ### Node installation
 
 * Note, building the static interface will require a valid Node.js installation