git commit messgae 规范化

最新推荐文章于 2024-06-29 15:57:46 发布

官方小可爱√

最新推荐文章于 2024-06-29 15:57:46 发布

阅读量426

点赞数 1

文章标签： git

本文链接：https://blog.csdn.net/weixin_46813929/article/details/114306155

版权

本文介绍了Git commit message的规范化，遵循Angular团队的Conventional Commits specification，详细讲解了message格式，并提供了安装与使用的步骤，包括使用commitizen工具和cz-conventional-changelog Adapter，以帮助生成合规的commit消息。

摘要由CSDN通过智能技术生成

文章目录

git commit messgae 规范化 & 格式化

git commit messgae 规范化 & 格式化

介绍：

git commit message 是一套约定式提交规范，用于形成规范化的提交记录，使之清晰，方便

格式举例：

目前规范使用较多的是 Angular 团队的规范, 继而衍生了 Conventional Commits specification. 很多工具也是基于此规范, 它的 message 格式如下:

<type>(<scope>): <subject> 标题行 必填
<BLANK LINE> 描述为什么修改, 做了什么样的修改, 以及开发的思路等等
<body>
<BLANK LINE>
<footer> 放 Breaking Changes 或 Closed Issues

工具安装：

安装步骤：

安装脚手架工具 commitizen/cz-cli，它提供了一个git cz 命令，用于替代git commit 命令,帮助生成符合规范的commit message
为commitizen 制定一个Adapter，此处使用 cz-conventional-changelog (一个符合 Angular团队规范的 preset). 使得 commitizen 按照我们指定的规范帮助我们生成 commit message.
安装方式：