File: check.md

package info (click to toggle)
commitizen 4.10.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,892 kB
  • sloc: python: 17,728; makefile: 15
file content (27 lines) | stat: -rw-r--r-- 618 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Check Options

<!-- When adding a new option, please keep the alphabetical order. -->

## `allow_abort`

- Type: `bool`
- Default: `False`

Disallow empty commit messages. Useful in CI.

## `allowed_prefixes`

- Type: `list`
- Default: `["Merge", "Revert", "Pull request", "fixup!", "squash!"]`

List of prefixes that commitizen ignores when verifying messages.

## `message_length_limit`

- Type: `int`
- Default: `0` (no limit)

Maximum length of the commit message. Setting it to `0` disables the length limit.

!!! note
    This option can be overridden by the `-l/--message-length-limit` command line argument.