From 5c093a62ba5a0fdf1633e4c1bbb60c2ba3205f49 Mon Sep 17 00:00:00 2001 From: shane knapp Date: Mon, 4 Nov 2024 10:11:39 -0800 Subject: [PATCH] small readability updates to the readme --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 24639cc1d..92b9a7f8a 100644 --- a/README.md +++ b/README.md @@ -31,12 +31,18 @@ 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. +The previous step, `pip install -r dev-requirements.txt`, installs the package +[`pre-commit`](https://pre-commit.com/). This is used to run a series of +commands defined in the file [`.pre-commit-config.yaml`](https://github.com/berkeley-dsep-infra/datahub/blob/staging/.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` +After you've installed `dev-requirements.txt`, execute the following two +commands: + +``` +pre-commit install +pre-commit run --all-files +``` ## Setting up your fork and clones