From 7fc5232a987641f3b0c2204b64909ba713e4e9a0 Mon Sep 17 00:00:00 2001 From: Dan Ditomaso Date: Tue, 18 Mar 2025 21:09:11 -0400 Subject: [PATCH] added details about pre-commit hooks --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 10e4678d..1cbb3121 100644 --- a/README.md +++ b/README.md @@ -97,10 +97,23 @@ instructions listed on the home page. Install the dependencies. ```bash -deno i +deno install ``` -Start the development server: +### Install Git Hooks (Optional but highly recommended) + +This project uses the npm package `simple-git-hooks` to enforce linting and +formatting before you are allowed to commit. Run the following command once on +your machine after cloning or installing dependencies: + +```bash +deno task install-hooks +``` + +This will install the pre-commit hook that runs `deno task lint:fix` and +`deno task format` before every commit. + +### Start the development server: ```bash deno task dev