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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# commit-check configuration file
# Rename to .commit-check.toml and place it in your repository root.
# All fields are optional. CLI flags override values set here.
# Allow commit types beyond the 11 standard ones (feat, fix, docs, …).
# Set to false to restrict commits to standard types only.
# Default: true
# allow_custom_types = true
# Maximum number of characters allowed in the commit description.
# Default: 72
# max_length = 72
# Minimum number of characters required in the commit description.
# 0 means no minimum is enforced.
# Default: 0
# min_length = 0
# Require the commit description to start with a lowercase letter.
# Default: true
# enforce_lowercase = true
# Reject descriptions that end with a period.
# Default: true
# disallow_period = true
# Require every commit to include a scope, e.g. feat(api): …
# Default: false
# require_scope = false
# Reject scopes that contain uppercase letters.
# Default: false
# enforce_lowercase_scope = false
# Comma-separated list of allowed scopes.
# When set, any scope not in this list is rejected.
# Omit the field (or leave it commented out) to allow any scope.
# Default: (unrestricted)
# scopes = "api,client,shared"
# Regex pattern that at least one commit footer must match.
# Useful for enforcing a link to an issue tracker on every commit.
# Default: (no pattern required)
# issue_pattern = "^Refs: #\\d+" # GitHub-style
# issue_pattern = "^Fixes: [A-Z]+-\\d+" # Jira-style
# ── Body cleaning ─────────────────────────────────────────────────────────────
# Automatically remove unwanted lines from the commit body before validation.
# Cleaning also collapses consecutive blank lines and trims trailing whitespace.
# Removed lines are printed to stdout so you can see what was stripped.
#
# Lines whose trimmed content starts with any of these comma-separated prefixes
# are removed. Useful for stripping attribution trailers added by tools.
# Default: (no rules)
# clean_starts_with = "Co-authored-by,Signed-off-by"
#
# Lines whose trimmed content matches any of these comma-separated regex patterns
# are removed. Note: avoid commas inside patterns; use [,] if needed.
# Default: (no patterns)
# clean_regex = "^🤖.*,^Generated-by:.*"