规则
¥Rules
body-full-stop
条件:
body以value结尾¥condition:
bodyends withvalue规则:
never¥rule:
nevervalue
text'.'
body-leading-blank
条件:
body以空行开头¥condition:
bodybegins with blank line规则:
always¥rule:
always
body-empty
条件:
body为空¥condition:
bodyis empty规则:
never¥rule:
never
body-max-length
条件:
body包含value个或更少个字符¥condition:
bodyhasvalueor less characters规则:
always¥rule:
alwaysvalue
textInfinity
body-max-line-length
条件:
body行包含value个或更少的字符。¥condition:
bodylines hasvalueor less characters规则:
always¥rule:
alwaysvalue
textInfinity
body-min-length
条件:
body包含value个或更多个字符¥condition:
bodyhasvalueor more characters规则:
always¥rule:
alwaysvalue
text0
body-case
条件:
body位于value的 case 中¥condition:
bodyis in casevalue规则:
always¥rule:
alwaysvalue
text'lower-case'可能的值
¥possible values
js[ "lower-case", // default "upper-case", // UPPERCASE "camel-case", // camelCase "kebab-case", // kebab-case "pascal-case", // PascalCase "sentence-case", // Sentence case "snake-case", // snake_case "start-case", // Start Case ];
footer-leading-blank
条件:
footer以空行开头¥condition:
footerbegins with blank line规则:
always¥rule:
always
footer-empty
条件:
footer为空¥condition:
footeris empty规则:
never¥rule:
never
footer-max-length
条件:
footer包含value个或更少个字符¥condition:
footerhasvalueor less characters规则:
always¥rule:
alwaysvalue
textInfinity
footer-max-line-length
条件:
footer行包含value个或更少的字符。¥condition:
footerlines hasvalueor less characters规则:
always¥rule:
alwaysvalue
textInfinity
footer-min-length
条件:
footer包含value个或更多个字符¥condition:
footerhasvalueor more characters规则:
always¥rule:
alwaysvalue
text0
header-case
条件:
header位于value的 case 中¥condition:
headeris in casevalue规则:
always¥rule:
alwaysvalue
text'lower-case'可能的值
¥possible values
js[ "lower-case", // default "upper-case", // UPPERCASE "camel-case", // camelCase "kebab-case", // kebab-case "pascal-case", // PascalCase "sentence-case", // Sentence case "snake-case", // snake_case "start-case", // Start Case ];
header-full-stop
条件:
header以value结尾¥condition:
headerends withvalue规则:
never¥rule:
nevervalue
text'.'
header-max-length
条件:
header包含value个或更少个字符¥condition:
headerhasvalueor less characters规则:
always¥rule:
alwaysvalue
text72
header-min-length
条件:
header包含value个或更多个字符¥condition:
headerhasvalueor more characters规则:
always¥rule:
alwaysvalue
text0
header-trim
条件:
header行首和/或尾随不能有空格。¥condition:
headermust not have initial and / or trailing whitespaces规则:
always¥rule:
always
references-empty
条件:
references至少包含一个条目¥condition:
referenceshas at least one entry规则:
never¥rule:
never
scope-enum
条件:
scope位于值中¥condition:
scopeis found in value规则:
always¥rule:
alwaysvalue
text[]
NOTE
如果消息中未提供作用域或值 > 为空数组,则此规则始终有效。
¥This rule always passes if no scopes are provided in the message or the value > is an empty array.
设置为
always时,所有消息范围都必须在值中找到。¥When set to
always, all message scopes must be found in the value.设置为
never时,任何消息范围都无法在值中找到。¥When set to
never, none of the message scopes can be found in the value.
scope-case
条件:
scope位于value的 case 中¥condition:
scopeis in casevalue规则:
always¥rule:
alwaysvalue
text'lower-case'可能的值
¥possible values
[
"lower-case", // default
"upper-case", // UPPERCASE
"camel-case", // camelCase
"kebab-case", // kebab-case
"pascal-case", // PascalCase
"sentence-case", // Sentence case
"snake-case", // snake_case
"start-case", // Start Case
];scope-empty
条件:
scope为空¥condition:
scopeis empty规则:
never¥rule:
never
scope-max-length
条件:
scope包含value个或更少个字符¥condition:
scopehasvalueor less characters规则:
always¥rule:
alwaysvalue
Infinityscope-min-length
条件:
scope包含value个或更多个字符¥condition:
scopehasvalueor more characters规则:
always¥rule:
alwaysvalue
0subject-case
条件:
subject位于value的 case 中¥condition:
subjectis in casevalue规则:
always¥rule:
alwaysvalue
["sentence-case", "start-case", "pascal-case", "upper-case"];可能的值
¥possible values
[
"lower-case", // lower case
"upper-case", // UPPERCASE
"camel-case", // camelCase
"kebab-case", // kebab-case
"pascal-case", // PascalCase
"sentence-case", // Sentence case
"snake-case", // snake_case
"start-case", // Start Case
];subject-empty
条件:
subject为空¥condition:
subjectis empty规则:
never¥rule:
never
subject-full-stop
条件:
subject以value结尾¥condition:
subjectends withvalue规则:
never¥rule:
nevervalue
'.'subject-max-length
条件:
subject包含value个或更少个字符¥condition:
subjecthasvalueor less characters规则:
always¥rule:
alwaysvalue
Infinitysubject-min-length
条件:
subject包含value个或更多个字符¥condition:
subjecthasvalueor more characters规则:
always¥rule:
alwaysvalue
0subject-exclamation-mark
条件:
subject在:标记前有一个感叹号¥condition:
subjecthas exclamation before the:marker规则:
never¥rule:
never
type-enum
条件:
type位于值中¥condition:
typeis found in value规则:
always¥rule:
alwaysvalue
js[ "build", "chore", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test", ];
type-case
描述:
type位于value的 case 中¥description:
typeis in casevalue规则:
always¥rule:
alwaysvalue
text'lower-case'可能的值
¥possible values
js[ "lower-case", // default "upper-case", // UPPERCASE "camel-case", // camelCase "kebab-case", // kebab-case "pascal-case", // PascalCase "sentence-case", // Sentence case "snake-case", // snake_case "start-case", // Start Case ];
type-empty
条件:
type为空¥condition:
typeis empty规则:
never¥rule:
never
type-max-length
条件:
type包含value个或更少个字符¥condition:
typehasvalueor less characters规则:
always¥rule:
alwaysvalue
textInfinity
type-min-length
条件:
type包含value个或更多个字符¥condition:
typehasvalueor more characters规则:
always¥rule:
alwaysvalue
text0
signed-off-by
条件:
message包含value¥condition:
messagehasvalue规则:
always¥rule:
alwaysvalue
text'Signed-off-by:'
trailer-exists
条件:
message包含尾随value¥condition:
messagehas trailervalue规则:
always¥rule:
alwaysvalue
text'Signed-off-by:'