From 24717587d3af3f3a65dd746fae1c11d766529ded Mon Sep 17 00:00:00 2001 From: Milan Malfait Date: Mon, 4 Dec 2023 14:38:21 +0000 Subject: [PATCH] Add pre-commit installation instructions (#166) --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 41664173b..5caf78494 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,14 @@ bin/run-all-tests.sh ``` and not just the component you have been working on as this will help us catch unintentional regressions without spending GH actions minutes :-) +We run [pre-commit](https://pre-commit.com/) as part of the GitHub Actions CI. To install and run it locally, do: + +```sh +pip install pre-commit +pre-commit install +``` + +The configuration can be found in [`.pre-commit-config.yml`](./.pre-commit-config.yaml) ## Assumptions