From e9031a4d80ff7e7387bd89da328a9638d5a20f37 Mon Sep 17 00:00:00 2001 From: nlebovits Date: Tue, 30 Jul 2024 09:02:53 +0200 Subject: [PATCH] update front end docs to clarify python and pip installation for precommit --- docs/SETUP/FRONT_END.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/SETUP/FRONT_END.md b/docs/SETUP/FRONT_END.md index 401ba1af..1ca39195 100644 --- a/docs/SETUP/FRONT_END.md +++ b/docs/SETUP/FRONT_END.md @@ -22,7 +22,9 @@ Note: make sure to keep your fork up to date with the original repository by fol ### Precommit hook -We use a precommit hook to help with formatting and linting in our CI/CD pipeline. When setting up the repo, please first [make sure you have `pre-commit` installed](https://pre-commit.com/) using `pip` or another package manager. Once that's done, run `pre-commit install` in the root directory to set up the precommit hooks (configured in `.pre-commit-config.yaml`). +We use a precommit hook to help with formatting and linting in our CI/CD pipeline. When setting up the repo, please first [make sure you have `pre-commit` installed](https://pre-commit.com/) using `pip` or another package manager.\* Once that's done, run `pre-commit install` in the root directory to set up the precommit hooks (configured in `.pre-commit-config.yaml`). + +\*`pre-commit` relies on Python and is installed with `pip`. Python 3 ships by default on Unix systems (macOS and Linux) and `pip` is normally included in this. So, unless you're running Windows, both of these should already be accessible to you without any extra steps. If you're running Windows, see [the Python installation instrutions here](https://docs.python.org/3/using/windows.html). ### Nextjs App