Skip to content

Commit 264dff6

Browse files
feat: add pre-commit hook for spelling check in contributing guide
1 parent 65859bd commit 264dff6

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

docs/CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,8 @@ Spelling is checked with `cspell`:
160160
npm run test:spelling
161161
```
162162

163+
The repository pre-commit hook also runs this spelling check before each commit.
164+
163165
### Golden artifacts (regression testing)
164166

165167
Golden artifacts are reference outputs stored in `fixtures/golden/` that serve as snapshots for regression testing. They are a narrow contract guard for published artifacts, not a proof that the full pipeline is semantically correct.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"test:types": "tsc --noEmit"
5656
},
5757
"simple-git-hooks": {
58-
"pre-commit": "npx lint-staged"
58+
"pre-commit": "npx lint-staged && node --run test:spelling"
5959
},
6060
"lint-staged": {
6161
"*": [

0 commit comments

Comments
 (0)