From 9fad4b2d587a4e2b0f15431983640d0783f5d141 Mon Sep 17 00:00:00 2001
From: Iain Sproat <68657+iainsproat@users.noreply.github.com>
Date: Thu, 18 Jul 2024 11:57:59 +0100
Subject: [PATCH] docs(README): update contribution instructions to advise
 pre-commit install (#2516)

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

diff --git a/README.md b/README.md
index e929eabad..23bec59e2 100644
--- a/README.md
+++ b/README.md
@@ -146,6 +146,11 @@ When committing to git, an automated script will run. This will check that your
 - Please note that these additional checks will be run by Speckle's automated CI environment and non-conformances, if any, may prevent your Pull Request from being merged.
 - Please use the name of the package as the scope of your commit.
 - Note that `ggshield` requires you to [register an account](https://dashboard.gitguardian.com/auth/signup) and then [authorise with GitGuardian](https://github.com/GitGuardian/ggshield#initial-setup) before it can be used: `ggshield auth login`
+- Then run to enable pre-commit. This will run on every commit you make:
+
+  ```bash
+  pre-commit install
+  ```
 
 # Security