Skip to content

Commit 6c35ca0

Browse files
committed
docs: add simple setup test #775
1 parent a259014 commit 6c35ca0

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/guides-local-setup.md

+13
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,19 @@ Using `commit-msg` gives us exactly what we want: It is executed whenever a new
4545

4646
## Test
4747

48+
### Test simple usage
49+
50+
Fort a first simple usage test of commlitlint you can do the following:
51+
52+
```bash
53+
npx commitlint --from HEAD~1 --to HEAD --verbose
54+
```
55+
56+
This will check your last commit and return an error if invalid or a positive output if valid.
57+
58+
59+
### Test the hook
60+
4861
You can test the hook by simply committing. You should see something like this if everything works.
4962

5063
```bash

0 commit comments

Comments
 (0)