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
# Commit Message Validation Configuration Template
# The Conventional Commits specification is a lightweight convention on top of commit messages.
# For detailed content, please refer to: https://www.conventionalcommits.org/en/v1.0.0/#summary
# The commit message should be structured as follows:
#
# ╔═════════════════════════════════════════════════╗
# ║ COMMIT FORMAT TEMPLATE ║
# ╠═════════════════════════════════════════════════╣
# ║ type(optional scope): subject ║
# ║ ║
# ║ [optional body] ║
# ║ ║
# ║ [optional footer] ║
# ║ - BREAKING CHANGE: xxxxx ║
# ║ - Closes #issue ║
# ╚═════════════════════════════════════════════════╝
#
# Structure explanation:
# 1. type → Required, commit type (feat/fix/docs etc)
# 2. (scope) → Optional, scope (wrapped in parentheses)
# 3. : subject → Required, brief description (space after colon)
# 4. body → Optional, detailed description (blank line after header)
# 5. footer → Optional, notes (blank line after body)
#
rules:
# You can optionally modify, delete, or comment out the options that do not require validation.
# Type validation module
type:
allowed_types:
- feat # New feature
- fix # Bug fix
- docs # Documentation
- style # Code style
- refactor # Code refactor
- test # Test related
- chore # Maintenance
# Scope validation module
scope:
# allowed_scopes:
# - core
# - cli
# - ui
# - docs
# - test
# Subject validation module
subject:
require_space_after_colon: true #true is default value
min_length: 5 # default min_length is 1
max_length: 72 # default max_length is 72