Skip to content

Commit 6ec8169

Browse files
committed
docs(README.md): Add pre-commit integration information in README.md
1 parent 48c97b5 commit 6ec8169

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,20 @@ or the shortcut
7474
cz c
7575
```
7676

77+
### Integrating with Pre-commit
78+
Commitizen can lint your commit message for you with `cz check`.
79+
You can integrate this in your [pre-commit](https://pre-commit.com/) config with:
80+
```yaml
81+
---
82+
repos:
83+
- repo: https://github.com/commitizen-tools/commitizen
84+
rev: v1.17.0
85+
hooks:
86+
- id: commitizen
87+
stages: [commit-msg]
88+
```
89+
Read more about the `check` command [here](https://commitizen-tools.github.io/commitizen/check/).
90+
7791
### Help
7892

7993
```bash

0 commit comments

Comments
 (0)