From e76357230813f78ab0b48435b5e839614357eb5d Mon Sep 17 00:00:00 2001 From: Jake Low Date: Wed, 8 Jan 2025 12:08:12 -0800 Subject: [PATCH] Update developer instructions to mention pre-commit hook --- DEVELOPMENT.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index e963c5d1e..c3a72693a 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -198,10 +198,20 @@ Unit tests are built with [Jest](https://facebook.github.io/jest/) + Run `yarn format` to format your code. Run `yarn lint` to check for lint errors. +If you want, you can enable a pre-commit hook to check for linting and formatting +issues automatically when you run `git commit`. To enable the check, run this +command in the root of the repository: + +``` +git config core.hooksPath hooks +``` + +If you want to skip the check for a particular commit (for work-in-progress commits +for example), run `git commit --no-verify`. + ## CSS Styling and Naming -We are using SASS and [Tailwind -CSS](https://tailwindcss.com) with PostCSS. +We are using SASS and [Tailwind CSS](https://tailwindcss.com) with PostCSS. Tailwind configuration is controlled with the `src/tailwind.config.js` file. New CSS classes can be found in `src/styles/`