Git Commit Message 应该怎么写？

最新推荐文章于 2023-11-22 15:35:50 发布

VIP文章欧怼怼

最新推荐文章于 2023-11-22 15:35:50 发布

阅读量519

点赞数 2

文章标签： git

本文链接：https://blog.csdn.net/weixin_43803691/article/details/116594859

版权

因为入职至今，公司也没有太规定一个代码提交规范，所以一直以来，我代码提交的commit message都是简单的一句话说明了本次代码改动内容，有时候会更加精简。

但时间长了之后，当我需要回头找一下某次提交记录的时候，就会发现不太好找，首先没有一个具体的分类，比如是添加功能、还是修复bug、还是更新文档等等；其次就是有一些message写得不是很清晰，不太能一眼明了那次改动是什么内容。

后来决定，需要重新学一学关于commit message的写法规范。

Commit Message的好处

目前Commit Message规范使用较多的是Angular团队的规范，继而衍生了Conventional Commits sepcification。

Commit Message包括三个部分：Header、Body和Footer。格式如下：

<type>(<scope>): <subject>
< 空一行 >
<body>
< 空一行 >
<footer>

其中，Header是必填的，Body和Footer可以省略不写。

Header包含三个部分：type、scope和subject。其中scope是可选项。

<type>(<scope>): <subject>

# example
feat($route): add support for the `reloadOnUrl` configuration option

type是用于说明commit的类别，具体的标识如下：

关注