From 5296643ad9d28752de51724bf4af7c676dd72ffc Mon Sep 17 00:00:00 2001 From: sean-morris Date: Sun, 3 Nov 2024 15:08:39 -0800 Subject: [PATCH] Updated README - pre-commit config --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index e56cd0814..24639cc1d 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,15 @@ editing, testing, building and deploying hubs. The other python package definition file, `requirements.txt` is used solely by our Github Actions CI/CD pipeline. +## Pre-Commit hooks: Installing + +The previous step, `pip install -r dev-requirements.txt`, installs the package, pre-commit. +This is used to run a series of commands defined in the file, .pre-commit-config.yaml, to help ensure no mistakes are committed to the repo. + +After the pip install command execute the following: +-- `pre-commit install` +-- `pre-commit run --all-files` + ## Setting up your fork and clones First, go to your [github profile settings](https://github.com/settings/keys)