git commit规范和约定式提交【详解】

轻墨同学_9825

轻墨同学_9825

2026-05-05

891人浏览

原创

conventional commits规范要求header严格匹配type(scope): subject格式,type须小写且为预定义值,scope可选但需英文括号包裹,subject首字母小写、结尾无句号、长度≤50字符,冒号后必须空格;自动化工具依赖此结构解析。

git commit规范和约定式提交【详解】

Git 提交信息不是写给机器看的,但规范的格式能让机器自动解析、生成 ChangeLog、过滤提交、识别破坏性变更——前提是人先写对。

conventional commit 的 header 格式必须严格匹配 type(scope): subject

这是所有自动化工具(比如 conventional-changelog、semantic-release)能工作的前提。不满足这个结构,脚本就无法提取 type 或判断是否为 feat / fix。

  • type 必须是小写,且仅限预定义值:常见有 feat、fix、docs、style、refactor、perf、test、build、chore;自定义类型需团队统一约定并同步到工具配置中
  • scope 是可选的,但一旦使用,必须用英文括号包裹,多个 scope 用逗号分隔,如 feat(auth,api): ...;不要写成 feat(auth, api):(空格非法)或 feat[auth]:(方括号不识别)
  • subject 开头字母小写,结尾不加句号;长度建议 ≤50 字符;冒号后必须跟一个空格,feat(api):add user 是错的,feat(api): add user 才对

commit-msg hook 拦截不合规提交时,错误常来自正则误配或空格处理

很多团队用 husky + commit-msg 钩子校验格式,但本地提交仍能绕过,往往是因为正则没覆盖空格、换行或中文标点。

Github Auto
Github Auto

管PR、盯Issue、跑CI、发Release——GitHub仓库日常运维扔给它。少开几个Chrome标签页。

下载
  • 典型错误正则:^feat|fix|docs|... —— 缺少锚定和完整匹配,会把 xxx feat: yyy 也当成合法
  • 正确写法应类似:^(feat|fix|docs|...)(\([^)]*\))?: [a-z].*,注意开头 ^、结尾 $、空格和小写字母约束
  • 如果项目允许中文 subject,正则里不能硬写 [a-z],而要用 [^\n] 或更宽松的字符集,否则中文提交直接被拒
  • 钩子脚本里读取 commit message 时,别直接用 cat $1,要 head -n1 $1 只取第一行 header,否则 body 或 footer 里的内容会干扰匹配

用 git cz 替代 git commit 时,cz-config 必须与团队规范对齐

git cz 不是开箱即用的“自动规范”,它只是把填空题搬到了终端里。填什么、怎么填,全由 .cz-config.js 或 cz-conventional-changelog 版本决定。

  • 默认 cz-conventional-changelog@3.x 对应 Angular 规范,type 列表较老(不含 perf),若团队用 perf,需升级到 @4.x 或手动 patch types 配置
  • scope 提示文案默认是 “scope (optional)”,但团队若强制要求所有提交带 scope(如按模块名 user、order),就得改 questions 配置,把 scope 设为 required 并提供下拉选项
  • 如果项目用 Monorepo,不同 package 有不同 scope 约束,cz 默认不支持动态 scope 列表,得配合 cz-customizable 或写自定义 adapter

ChangeLog 自动生成失败,大概率卡在 footer 解析或版本前缀上

conventional-changelog 工具链依赖 commit footer 中的 Closes #123 或 BREAKING CHANGE:,但这些字段对格式极其敏感。

  • BREAKING CHANGE: 必须独占一行,且冒号后要有空格;写成 BREAKING CHANGE:旧接口已移除 会被忽略,必须是 BREAKING CHANGE: 旧接口已移除
  • Closes #123、Fixes #456 等关键词必须出现在 footer 区域(header 和 body 之后、最后一个空行之下),写在 body 里无效
  • 生成 ChangeLog 时若指定 --release-count 0 却没输出,检查最近一次 tag 是否符合 v1.2.3 格式;用 git tag 看到的是 1.2.3 或 release/1.2.3,工具就无法识别为语义化版本起点

最常被跳过的细节是:header 行末不能有多余空格,footer 的关键词必须顶格写,以及所有工具(cz / husky / conventional-changelog)的版本必须协同升级——差一个小版本,type 列表或解析逻辑就可能对不上。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

git

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3049

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2268

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1220

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1158

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2098

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3360

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15075

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.9万人学习