Skip to content

Commit 08931f7

Browse files
authored
doc: Add example for checking commit (#608)
1 parent cbb4dc7 commit 08931f7

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,17 @@ repos:
2020
- repo: https://github.com/streetsidesoftware/cspell-cli
2121
rev: v8.17.0
2222
hooks:
23-
- id: cspell
23+
- id: cspell # Spell check changed files
24+
- id: cspell # Spell check the commit message
25+
name: check commit message spelling
26+
args:
27+
- --no-must-find-files
28+
- --no-progress
29+
- --no-summary
30+
- --files
31+
- .git/COMMIT_EDITMSG
32+
stages: [commit-msg]
33+
always_run: true # This might not be necessary.
2434
```
2535
2636
<!-- x-release-please-end -->

cspell.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77
"node_modules",
88
"package-lock.json"
99
],
10-
"words": ["codeql", "streetsidesoftware", "workdir"]
10+
"words": ["codeql", "streetsidesoftware", "workdir", "COMMIT_EDITMSG"]
1111
}

0 commit comments

Comments
 (0)