Merge pull request #573 from button-inc/540-add-precommit-to-dev-guide

docs: added precommit to dev guide
button-inc · Oct 21, 2022 · 1564133 · 1564133
2 parents 6a360e2 + 8335be6
commit 1564133
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/developer-guide.md b/docs/developer-guide.md
@@ -17,6 +17,14 @@
 - Run `yarn storybook:<theme>` where `<theme>` is `bcgov`, `button`, or your custom theme
 - Storybook will open in a browser
 
+### Set Up Pre-Commit Locally
+
+- See [docs](https://github.com/button-inc/digital_marketplace/blob/main/docs/pre-commit.md) for setup
+- Run `bash .git/hooks/pre-commit` from repo to execute pre-commit on staged files without commiting
+
+What are [pre-commit hooks](https://pre-commit.com/)?
+
+
 ### Test
 
 To run unit tests in all packages, run `yarn test:jest`