git使用Conventional Commits规范提交信息【攻略】

梦墨酱_5580

梦墨酱_5580

2026-04-22

964人浏览

原创

遵循conventional commits规范需四步:一、手动构建type(scope): subject格式提交;二、用commitizen交互生成;三、配husky+commitlint提交前校验;四、在ide中安装插件集成。

git使用conventional commits规范提交信息【攻略】 - php中文网

如果您在使用 Git 提交代码时希望提交信息具备可读性、可解析性和自动化友好性,则需遵循 Conventional Commits 规范。以下是实现规范化提交信息的具体操作路径:

一、手动构建符合规范的提交信息

该方法直接通过 git commit -m 命令构造结构化消息,适用于轻量项目或临时提交场景,无需额外工具依赖。其核心在于严格遵守 Header 行的语法约束,并合理组织可选的正文与脚注。

1、确定提交类型(type),从 feat、fix、docs、style、refactor、perf、test、chore、build 中选择一项;

2、可选添加作用域(scope),用圆括号包裹,例如 (ui)、(auth)、(api);

3、在冒号后空一格,以动词原形开头撰写不超过 50 字的简短描述(subject),首字母小写、不加句号;

4、如需补充上下文,在 subject 后空一行写入正文(body),说明修改原因及影响范围;

5、如涉及破坏性变更,在正文后空一行添加以 BREAKING CHANGE: 开头的脚注;如修复 issue,可写入 Closes #123 或 Fixes #456。

二、使用 commitizen 交互式生成提交信息

该方法通过命令行向导引导用户逐项输入必要字段,自动拼接为合规格式,显著降低记忆成本与手误风险,适合团队统一入口场景。

1、全局安装 commitizen 与 cz-conventional-changelog 适配器:npm install -g commitizen cz-conventional-changelog;

2、在用户主目录创建配置文件 ~/.czrc,内容为 {"path": "cz-conventional-changelog"};

3、进入项目根目录,执行 git cz 启动交互流程;

4、按提示依次选择变更类型、填写作用域、输入简短描述、补充长描述、确认是否含破坏性变更、关联 issue 编号;

5、确认后自动生成完整提交信息并完成提交。

git-dirty-check
git-dirty-check

对本地 Git 工作树进行只读整理,汇总未提交变更并给出保守风险标记。用于用户询问…的变更。

下载

三、配置 husky + commitlint 实现提交前校验

该方法在 git commit 触发时自动检查消息格式,拒绝不符合 Conventional Commits 规则的提交,保障仓库历史质量底线,适用于中大型协作项目。

1、项目内安装 husky 与 @commitlint/cli、@commitlint/config-conventional:npm install -D husky @commitlint/cli @commitlint/config-conventional;

2、初始化 husky 并添加 commit-msg 钩子:npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"';

3、创建 commitlint.config.js 文件,内容为 module.exports = { extends: ['@commitlint/config-conventional'] };;

4、验证配置:尝试提交一条非规范消息(如 git commit -m "update readme"),将被拦截并提示错误;

5、仅当消息匹配 type(scope): subject 格式且 type 在允许列表中时,提交才被放行。

四、在 IDE 中集成 Conventional Commits 插件

该方法将规范提交流程嵌入日常开发界面,避免切换终端,提升前端与全栈开发者操作连贯性,尤其适合 JetBrains 系列 IDE 用户。

1、打开 IDEA 或 WebStorm 的 Settings → Plugins → Marketplace;

2、搜索并安装 Conventional Commit 插件;

3、重启 IDE 后,在 Commit 工具窗口点击右上角小红点(Commit Message Assistant);

4、在弹出面板中选择 type、输入 scope、填写 subject 和 body;

5、点击 Insert 按钮,自动生成格式正确的内容并填入提交框,支持一键提交。

相关文章

热门游戏推荐
热门游戏推荐

海量精品小游戏合集,无需安装即点即玩,休闲益智、动作闯关应有尽有,秒开即玩,轻松解压,快乐停不下来

下载

相关标签:

git

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

相关专题

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

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

2023.06.20

3089

3

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

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

2023.07.25

2288

9

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

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

2023.08.02

1220

5

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

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

2023.08.09

1178

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

2118

7

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

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

2023.09.20

3400

8

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

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

2023.09.22

15315

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万人学习