Skip to content

Commit

Permalink
Make it clear unit tests don't run in pre-commit hook
Browse files Browse the repository at this point in the history
  • Loading branch information
Rhys Koedijk committed Nov 19, 2024
1 parent 48d2797 commit 44f10eb
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,9 @@ codespell --write-changes # to automatically fix misspellings

## Automatically run quality checks on commit

If you'd like spelling, formatting, and linting checks to be run automatically on commit, enable the [Husky](https://typicode.github.io/husky/how-to.html) git hooks using `npx husky`; When enabled, your local commits will be rejected if any of the quality checks fail.
If you'd like spelling, formatting, and linting checks to be run automatically on commit, enable the [Husky](https://typicode.github.io/husky/how-to.html) git hooks using:
```bash
npx husky
```

When enabled, your local commits will be rejected if any of the quality checks fail; Unit tests are **not** run due to their long execution time, you must still them manually.

0 comments on commit 44f10eb

Please sign in to comment.