Skip to content

Commit

Permalink
Update developer instructions to mention pre-commit hook
Browse files Browse the repository at this point in the history
  • Loading branch information
jake-low committed Jan 8, 2025
1 parent 1a276d1 commit e763572
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/`
Expand Down

0 comments on commit e763572

Please sign in to comment.