Skip to content

Commit 20cda61

Browse files
committed
docs: update usage
1 parent d3e948f commit 20cda61

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ print(is_conventional("custom: this is a conventional commit", types=["custom"])
139139

140140
```shell
141141
$ conventional-pre-commit -h
142-
usage: conventional-pre-commit [-h] [--no-color] [--force-scope] [--scopes SCOPES] [--strict] [--verbose] [types ...] input
142+
usage: conventional-pre-commit [-h] [--no-color] [--force-scope] [--scopes SCOPES] [--skip-merges] [--strict] [--verbose] [types ...] input
143143
144144
Check a git commit message for Conventional Commits formatting.
145145
@@ -151,9 +151,9 @@ options:
151151
-h, --help show this help message and exit
152152
--no-color Disable color in output.
153153
--force-scope Force commit to have scope defined.
154-
--scopes SCOPES Optional list of scopes to support. Scopes should be separated by commas with no spaces (e.g. api,client)
155-
--skip-merges Do not check format for merge commits.
156-
--strict Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.
154+
--scopes SCOPES List of scopes to support. Scopes should be separated by commas with no spaces (e.g. api,client).
155+
--skip-merges Skip Conventional Commits format check for merge commits. Not compatible with --strict.
156+
--strict Force commit to strictly follow Conventional Commits formatting. Disallows fixup! and merge commits.
157157
--verbose Print more verbose error output.
158158
```
159159

0 commit comments

Comments
 (0)