Skip to content

Commit e691bf9

Browse files
committed
Add Husky docs to README.
1 parent 66dda06 commit e691bf9

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,18 @@ npm run tsc
9292

9393
Runs `tsc --noEmit`, which will compile the TypeScript code without emitting files. This acts as a TS error check in your CLI. This is useful to catch TS errors that you might miss during development. For more information, see the [TypeScript Compiler (tsc) documentation](https://www.typescriptlang.org/docs/handbook/compiler-options.html).
9494

95+
## Husky
96+
97+
This project uses [Husky](https://typicode.github.io/husky/#/) to check code on git commits. By default, it is setup to use the `npm test` script which runs `lint`, `prettier`, and `tsc` (TypeScript) checks against the codebase. This check occurs on `git commit` attempts. This helps developers catch errors _before_ pushing branches and creating PRs, quickening the overall dev worklow.
98+
99+
To bypass this check, you can use the `--no-verify` flag with your commit:
100+
101+
```bash
102+
git commit -m "This will not get checked by Husky." --no-verify
103+
```
104+
105+
Note that bypassing the Husky check is frowned upon.
106+
95107
## Notes
96108

97109
* Code for the app is currently configured to go into the `pages` directory (for [Next.js pages](https://nextjs.org/docs/basic-features/pages)) and `source` for theming, components, providers, helpers, etc.

0 commit comments

Comments
 (0)