https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html

Commit message 和 Change log 编写指南

字数

6853 字

阅读时间

29 分钟

作者：阮一峰

日期： 2016年1月 6日

Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。

bash


$ git commit -m "hello world"

上面代码的-m参数，就是用来指定 commit mesage 的。

如果一行不够，可以只执行git commit，就会跳出文本编辑器，让你写多行。

bash


$ git commit

基本上，你写什么都行（这里，这里和这里）。

但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。

目前，社区有多种 Commit message 的写法规范。本文介绍Angular 规范（见上图），这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。

一、Commit message 的作用

格式化的Commit message，有几个好处。

（1）提供更多的历史信息，方便快速浏览。

比如，下面的命令显示上次发布后的变动，每个commit占据一行。你只看行首，就知道某次 commit 的目的。

bash

> 
> $ git log <last tag> HEAD --pretty=format:%s
> ```

![](http://www.ruanyifeng.com/blogimg/asset/2016/bg2016010604.png)

**（2）可以过滤某些commit（比如文档改动），便于快速查找信息。**

比如，下面的命令仅仅显示本次发布新增加的功能。

```bash
> 
> $ git log <last release> HEAD --grep feature
> ```

**（3）可以直接从commit生成Change log。**

Change Log 是发布新版本时，用来说明与上一个版本差异的文档，详见后文。

![](http://www.ruanyifeng.com/blogimg/asset/2016/bg2016010603.png)

## 二、Commit message 的格式

每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。

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

其中，Header 是必需的，Body 和 Footer 可以省略。

不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

2.1 Header

Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。

（1）type

type用于说明 commit 的类别，只允许使用下面7个标识。

feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style：格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动

如果type为feat和fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。

（2）scope

scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

（3）subject

subject是 commit 目的的简短描述，不超过50个字符。

以动词开头，使用第一人称现在时，比如change，而不是changed或changes
第一个字母小写
结尾不加句号（.）

2.2 Body

Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。

bash


More detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

有两个注意点。

（1）使用第一人称现在时，比如使用change而不是changed或changes。

（2）应该说明代码变动的动机，以及与以前行为的对比。

Footer 部分只用于两种情况。

（1）不兼容变动

如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。

bash


BREAKING CHANGE: isolate scope bindings definition has changed.

    To migrate the code follow the example below:

    Before:

    scope: {
      myAttr: 'attribute',
    }

    After:

    scope: {
      myAttr: '@',
    }

    The removed `inject` wasn't generaly useful for directives so there should be no code using it.

（2）关闭 Issue

如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。

bash


Closes #234

也可以一次关闭多个 issue 。

bash


Closes #123, #245, #992

2.4 Revert

还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。

bash


revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Body部分的格式是固定的，必须写成This reverts commit <hash>.，其中的hash是被撤销 commit 的 SHA 标识符。

如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change log 的Reverts小标题下面。

三、Commitizen

Commitizen是一个撰写合格 Commit message 的工具。

安装命令如下。

bash


$ npm install -g commitizen

然后，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。

bash


$ commitizen init cz-conventional-changelog --save --save-exact

以后，凡是用到git commit命令，一律改为使用git cz。这时，就会出现选项，用来生成符合格式的 Commit message。

四、validate-commit-msg

validate-commit-msg 用于检查 Node 项目的 Commit message 是否符合格式。

它的安装是手动的。首先，拷贝下面这个JS文件，放入你的代码库。文件名可以取为validate-commit-msg.js。

接着，把这个脚本加入 Git 的 hook。下面是在package.json里面使用 ghooks，把这个脚本加为commit-msg时运行。

javascript

> 
>   "config": {
>     "ghooks": {
>       "commit-msg": "./validate-commit-msg.js"
>     }
>   }
> ```

然后，每次`git commit`的时候，这个脚本就会自动检查 Commit message 是否合格。如果不合格，就会报错。

```bash
> 
> $ git add -A 
> $ git commit -m "edit markdown" 
> INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" ! was: edit markdown
> ```

## 五、生成 Change log

如果你的所有 Commit 都符合 Angular 格式，那么发布新版本时， Change log 就可以用脚本自动生成（[例1](https://github.com/ajoslin/conventional-changelog/blob/master/CHANGELOG.md)，[例2](https://github.com/karma-runner/karma/blob/master/CHANGELOG.md)，[例3](https://github.com/btford/grunt-conventional-changelog/blob/master/CHANGELOG.md)）。

生成的文档包括以下三个部分。

> - New features
> - Bug fixes
> - Breaking changes.

每个部分都会罗列相关的 commit ，并且有指向这些 commit 的链接。当然，生成的文档允许手动修改，所以发布前，你还可以添加其他内容。

[conventional-changelog](https://github.com/ajoslin/conventional-changelog) 就是生成 Change log 的工具，运行下面的命令即可。

```bash
> 
> $ npm install -g conventional-changelog
> $ cd my-project
> $ conventional-changelog -p angular -i CHANGELOG.md -w
> ```

上面命令不会覆盖以前的 Change log，只会在`CHANGELOG.md`的头部加上自从上次发布以来的变动。

如果你想生成所有发布的 Change log，要改为运行下面的命令。

bash

$ conventional-changelog -p angular -i CHANGELOG.md -w -r 0

为了方便使用，可以将其写入`package.json`的`scripts`字段。

```javascript
> 
> {
>   "scripts": {
>     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
>   }
> }
> ```

以后，直接运行下面的命令即可。

 ```bash
> 
> $ npm run changelog
> ```

（完）

### 文档信息

- 版权声明：自由转载-非商用-非衍生-保持署名（[创意共享3.0许可证](http://creativecommons.org/licenses/by-nc-nd/3.0/deed.zh)）
- 发表日期： 2016年1月 6日

## 相关文章

- **2023.08.08: [《TypeScript 教程》发布了](http://www.ruanyifeng.com/blog/2023/08/typescript-tutorial.html)**
    
    长话短说，我写了一本《TypeScript 教程》，已经发布在网道，欢迎大家访问。
    
- **2023.03.21: [运维的未来是平台工程](http://www.ruanyifeng.com/blog/2023/03/platform-engineering.html)**
    
    互联网公司有一个重要工种，叫做"运维"。
    
- **2022.10.23: [最简单的 Git 服务器](http://www.ruanyifeng.com/blog/2022/10/git-server.html)**
    
    程序员的代码仓库，总是需要托管一份在服务器，这样才保险，也方便使用。
    
- **2022.06.29: [云主机上手教程：轻量应用服务器体验](http://www.ruanyifeng.com/blog/2022/06/cloud-server-getting-started-tutorial.html)**
    
    很多同学都希望架设自己的云服务，这就离不开云主机（cloud server）。
    

## 留言（64条）

叫我布鲁斯 说：

昨天睡前还在想怎么从commit生成changelog，阮老师这篇文章真是太及时了

2016年1月 7日 00:44 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353822) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用叫我布鲁斯的这条留言")

小学生 说：

据说github能够识别CommitMsg里的一些动词，自动触发一些动作，请阮老师也一并讲讲吧。

2016年1月 7日 09:12 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353823) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用小学生的这条留言")

int64ago 说：

不多评论！有用！

2016年1月 7日 09:30 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353824) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用int64ago的这条留言")

TZ 说：

changelog 之前用 tj/git-extras

阮老师这篇应该还缺一个知识点: git release 相关.

2016年1月 7日 10:29 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353829) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用TZ的这条留言")

jiel 说：

哪有时间写那么详细的commit message 还干活不

2016年1月 7日 12:32 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353839) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用jiel的这条留言")

CodingNinja 说：

docs：文档（documentation）提交标识是什么意思？指的是项目中的非代码文件的改动？？

2016年1月 7日 13:54 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353843) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用CodingNinja的这条留言")

ArchiTech 说：

好细致

2016年1月 7日 15:25 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353844) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用ArchiTech的这条留言")

shengbin 说：

过于复杂了。如果是给开发者看的Changelog，直接看提交信息也可；如果是给用户看的，就不该自动生成。

2016年1月 7日 18:36 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353851) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用shengbin的这条留言")

John 说：

真不错！

2016年1月 7日 23:24 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353854) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用John的这条留言")

wicast 说：

commitizen为什么一定要做成引入package. json…………非js的项目也强制引入的做法也太不科学了……

JS程序员眼里世上只有一种编程语言么……

2016年1月 8日 14:17 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353879) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用wicast的这条留言")

walkskyer 说：

这篇文章真的很棒，一直不知道如何规范提交记录，项目的提交记录现在一团糟，看见这篇文章顿时茅塞顿开！赞一个！！！

2016年1月 8日 22:33 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353888) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用walkskyer的这条留言")

Fulei Li 说：

想问阮老师一个问题，如果用了Commitizen后，每次commit都是有标准格式了， validate-commit-msg这个工具应该再怎么配合使用？

2016年1月10日 15:06 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353915) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Fulei Li的这条留言")

zhangbobell 说：

> 引用CodingNinja的发言：
> 
> docs：文档（documentation）提交标识是什么意思？指的是项目中的非代码文件的改动？？

我的理解跟你的应该一样，比如 Readme.md 这种项目说明文档类的修改。

2016年1月12日 10:10 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353946) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用zhangbobell的这条留言")

yangzj1992 说：

太赞了！这个很不错！

2016年1月12日 18:00 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353957) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用yangzj1992的这条留言")

vvvv 说：

非node项目貌似不能支持?

2016年1月13日 04:51 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353964) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用vvvv的这条留言")

石樱灯笼博客 说：

日常开发commit怎么写……感觉也没写完啥功能或模块，只是想在git上备份一下

2016年1月13日 10:43 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353965) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用石樱灯笼博客的这条留言")

Rwing 说：

有win下的gui工具能实现严格过滤commit格式吗

2016年1月14日 16:40 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-353990) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Rwing的这条留言")

net1pei 说：

这些commit changelog内容很好，但怎么样应用于一个PHP项目？

2016年1月19日 10:52 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354138) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用net1pei的这条留言")

黄哲霆 说：

我们即将摘录您的文章《Commit message 和 Change log 编写指南》到苏州前端微信公众号，如有疑问及时联系我(qq:496406128)，也希望能莅临指导哈~微信号：suzhou_web

2016年1月21日 12:56 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354212) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用黄哲霆的这条留言")

carson 说：

光谷社区观光团组团来学习

2016年1月22日 13:44 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354242) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用carson的这条留言")

余宇轩 说：

在Commitizen部分  
在运行  
`commitizen init cz-conventional-changelog --save --save-exact`  
前，需要输入  
`npm init --yes`  
生成package.json

2016年1月28日 11:30 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354369) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用余宇轩的这条留言")

Loyalsoldier 说：

> 引用net1pei的发言：
> 
> 这些commit changelog内容很好，但怎么样应用于一个PHP项目？

因为都是 npm 模块……想必是要玩一下 node 环境的

2016年2月 1日 13:53 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354410) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Loyalsoldier的这条留言")

Loyalsoldier 说：

这篇文章相当有用！

国外的开源世界真的很标准，希望国内也要跟进啊……

2016年2月 1日 13:55 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354411) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Loyalsoldier的这条留言")

Doni 说：

下面这个版本是不包含命令行工具的  

  
npm install -g conventional-changelog  

是否是应该安装下面这个，才能够使用conventional-changelog命令？  

  
npm install -g conventional-changelog-cli  

2016年2月25日 08:01 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354654) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Doni的这条留言")

Mora 说：

写了个 shell 脚本，来做你上面的初始化操作

CZ_INIT_SCRIPT='var p=require("./package.json");p.config=p.config||{};p.config.ghooks={"commit-msg":"./node_modules/validate-commit-msg/index.js"};require("fs").writeFileSync("./package.json",JSON.stringify(p,null,2)+require("os").EOL);'  
alias cz_init="npm install ghooks validate-commit-msg --save-dev && commitizen init cz-conventional-changelog --save-dev --save-exact && node -e '$CZ_INIT_SCRIPT'"

2016年3月 7日 16:04 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354806) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Mora的这条留言")

magic 说：

应使用npm install -g conventional-changelog-cli这个  

2016年3月 8日 15:22 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354840) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用magic的这条留言")

小A 说：

文中说的应该是CLI

npm install -g conventional-changelog-cli

再者，根据官方Repo的描述，应该是下面的命令才对：

conventional-changelog -p angular -i CHANGELOG.md -s -r 0

2016年3月13日 17:28 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-354978) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用小A的这条留言")

石樱灯笼 说：

求助：  
比如说我增加了一个新功能，可以叫：  
feat：新功能（feature）

但如果我是把一个功能的内部逻辑调整了一下，比如聊天软件群发，以前是给所有在群里的人ring一下，现在变成把除自己之外的所有人ring一下。这个既不算代码优化，也不算bug修复，也不是新功能，这种应该叫什么？

2016年3月16日 10:30 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-355051) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用石樱灯笼的这条留言")

若惜勿忘 说：

> 引用石樱灯笼的发言：
> 
> 求助：  
> 比如说我增加了一个新功能，可以叫：  
> feat：新功能（feature）
> 
> 但如果我是把一个功能的内部逻辑调整了一下，比如聊天软件群发，以前是给所有在群里的人ring一下，现在变成把除自己之外的所有人ring一下。这个既不算代码优化，也不算bug修复，也不是新功能，这种应该叫什么？
> 
> 应该叫 refactor

2016年6月15日 15:47 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-358484) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用若惜勿忘的这条留言")

zouchao 说：

请问阮老师，body如何换行写？回车之后就让写关闭closed了

2016年6月15日 17:55 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-358578) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用zouchao的这条留言")

xingtao 说：

> 引用小A的发言：
> 
> 文中说的应该是CLI
> 
> npm install -g conventional-changelog-cli
> 
> 再者，根据官方Repo的描述，应该是下面的命令才对：
> 
> conventional-changelog -p angular -i CHANGELOG.md -s -r 0

太对啦，不用cli conventional-changelog会报错的，无法执行，是不是以前的安装都会默认安装cli，现在好多都要手动去安装cli命令

2016年8月 5日 16:37 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-361795) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用xingtao的这条留言")

runmin 说：

因项目需求变更导致的代码变更应该是哪种

2016年12月28日 16:19 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-371226) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用runmin的这条留言")

lindexi 说：

> 引用zouchao的发言：
> 
> 请问阮老师，body如何换行写？回车之后就让写关闭closed了

直接打 git commit 进入就可以打 i 然后写，可以输回车，下完按 w 保存

2017年4月 5日 14:55 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-375897) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用lindexi的这条留言")

过客 说：

oschina转载文章，但是没署具体的网址，只写了阮一峰的主页。太心机了。http://www.oschina.net/news/69705/git-commit-message-and-changelog-guide

2017年6月 9日 15:01 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-377805) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用过客的这条留言")

CodingNinja 说：

即使这样，有时还是很难写 Commit，对于有强迫症的人来说就更难受了，最好各大组织能开个会统一下，可以有多种风格的 Commit 样板供选择（比如 [gitmoji](https://gitmoji.carloscuesta.me/) 风格），然后各个 Git 程序都要有模板让你填空式 Commit，并且进一步提供规范检查，这一流程化下来，就规范清爽许多了！

2017年7月 7日 21:56 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-378565) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用CodingNinja的这条留言")

硬一峰 说：

changelog 命令有误应为 conventional-changelog -p angular -i CHANGELOG.md -s

2017年7月12日 16:07 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-378645) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用硬一峰的这条留言")

douking 说：

/bin/sh: ./validate-commit-msg.js: Permission denied

2017年8月 4日 18:19 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-379253) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用douking的这条留言")

贾晓磊 说：

"社区有多种 Commit message 的写法规范"  
这里添加的“写作规范”的链接打不开了呢...

2017年8月 8日 09:35 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-379332) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用贾晓磊的这条留言")

Lynn 说：

修改冲突后的提交信息应该怎么写？

2017年9月13日 14:16 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-380352) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Lynn的这条留言")

kevin 说：

请问，生成的changelog本身 提交又产生一个commit，如何处理，有相应的规范吗？

2017年10月27日 17:37 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-381742) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用kevin的这条留言")

hqqxxf 说：

阮老师，文档该更新了。有些仓库更新了

2017年11月 7日 19:40 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-382108) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用hqqxxf的这条留言")

H.K. 说：

validate-commit-msg配置了。

运行不起来啊。混乱commit 都能通过

随便写的Commit 都能通过

2018年5月16日 18:58 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-388927) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用H.K.的这条留言")

康虎 说：

你好，conventional-changelog -p angular -i CHANGELOG.md -s执行后，为啥会生成之前所有的commit信息，就算新打了tag，也不会在新tag下显示新commit的信息，而是显示所有commit信息，紧急求助

2018年12月28日 18:16 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-399183) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用康虎的这条留言")

fangxiaochao 说：

我想问一下各位如何判断当前提交的type,比如说我这次升级了一个三方依赖库的版本号，叫它supportA，然后给他也写了个对应的工具类，叫做SupportAUtils,然后我同时升级了版本号，也修复了ModuleB上面的几个问题，那么我type还有scope以及subject怎么写？  
我现在是这样思考的：因为这次又包含fix也包含chore也包乤含feat，我就把type写出最重要的模块，我的写法如下：

Fix($ModuleB): 修复了ModuleB上的一些异常

1.升级了supportA的版本号至 1.1.1  
2.新增对应工具类SupportAUtils  
3.修复了ModuleB上的几个异常

但是这样生成change Log的话非fix和feat也会写上去，希望各位能给我解惑，还是说我fix的时候就提交一次，chore的时候也提交一次，feat的时候在提交一次呢

2019年2月22日 13:56 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-408361) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用fangxiaochao的这条留言")

Sinosaurus 说：

`npm install -g conventional-changelog` 这个会报 `conventional-changelog ：command not found`  
因而得换成 `npm install -g conventional-changelog-cli` 便可以正常使用了  

2019年3月 4日 14:32 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-409718) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Sinosaurus的这条留言")

boxsnake 说：

@fangxiaochao：

  
fix、feat和chore分开提交，这个方法便于程序员目前手上只专注于一个功能点，也方便提交树的查看和Changelog的生成。虽然很多国内程序员对此会不太习惯，但是这对于项目来说，是个比较好的习惯。

PS：之前看过ThinkPHP的代码，都是什么“修正Bug”和“提交代码”之类毫无营养的提交注释，这些注释无论对Changelog还是开发者看提交树而言，都没有任何意义。

2019年3月14日 14:41 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-409893) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用boxsnake的这条留言")

boxsnake 说：

> 引用jiel的发言：
> 
> 哪有时间写那么详细的commit message 还干活不

一般来说，只需要写一行head就可以了，当然，其实还是有一些很常见的工具的，比如commitizen，这个可以通过选择类型，填写简要描述的方式，快速提交，而不需要手动去写Angular模式的提交注释。

2019年3月14日 14:45 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-409895) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用boxsnake的这条留言")

niexq 说：

阮老师，本篇第二句"上面代码的-m参数，就是用来指定 commit mesage 的。"中，message少了s。  
好文，已转载，谢谢。

2019年4月12日 14:13 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-410514) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用niexq的这条留言")

DEO 说：

$ npm install -g conventional-changelog  
|  
V  
$ npm install -g conventional-changelog-cli

2019年7月29日 18:14 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-412477) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用DEO的这条留言")

derkin 说：

npm WARN deprecated validate-commit-msg@2.14.0: Check out CommitLint which provides the same functionality with a more user-focused experience

lint 看上去最新的使用可以考虑，CommitLint

2019年8月 6日 15:02 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-412594) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用derkin的这条留言")

ZZY2357 说：

本人新手  
请问，我刚初始化一个空的仓库，只是添加了一些文件，没有任何功能，header该是什么？  
请求大佬指导

2020年4月 5日 19:22 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-417535) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用ZZY2357的这条留言")

徐彬 说：

我不想项目中，有其他无关 的代码。怎么做到用cz 呢？ 希望知道的同仁，可以说明一些。感谢

2020年4月21日 11:14 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-417876) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用徐彬的这条留言")

七仔 说：

学习了，最近才了解到还有feat、fix这种类别

2020年5月15日 10:51 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-418334) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用七仔的这条留言")

大雄 说：

npm install -g conventional-changelog 应该要改成  
npm install -g conventional-changelog-cli

2020年7月 9日 11:50 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-420223) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用大雄的这条留言")

Franklin-Qi 说：

阮老师这篇可以用于规范化commit，对于完整的项目开发很有帮助，学习了。

2020年10月20日 15:23 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-423332) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Franklin-Qi的这条留言")

chess99 说：

修改了CSS样式算什么type, feat? chore?

2020年11月 5日 21:59 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-423660) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用chess99的这条留言")

ChrisZZ 说：

感觉每次给commit分类是个好习惯，但实施起来遇到的困难是，不知道分到哪个type合理。例如要实现的功能是图像的rgb和bgr转换，在arm平台可以利用neon指令加速。那么当我实现了基本版本的转换功能，可以算feat；基于neon新实现了个加速版本的，算feat还是refactor？个人觉得refactor应该是把原有代码覆盖掉，并且有新替代。但优化实现的函数，从对外API角度来看，并没有增加新功能。

2020年11月 8日 18:54 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-423710) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用ChrisZZ的这条留言")

TheColdPot 说：

> 引用CodingNinja的发言：
> 
> docs：文档（documentation）提交标识是什么意思？指的是项目中的非代码文件的改动？？

大概就是README, CHANGELOG, CONTRIBUTE, ISSUE_TEMPLATE之类的

2021年1月31日 13:55 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-425366) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用TheColdPot的这条留言")

TheColdPot 说：

> 引用kevin的发言：
> 
> 请问，生成的changelog本身 提交又产生一个commit，如何处理，有相应的规范吗？

CHANGELOG一般是直接在CI生成，也就是不commit直接使用生成的CHANGELOG包含在项目文件中release

2021年5月 5日 23:54 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-426713) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用TheColdPot的这条留言")

chengjie 说：

第三行的message拼写有错，成了mesage

2021年5月24日 09:31 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-427018) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用chengjie的这条留言")

ckvv 说：

> 引用wicast的发言：
> 
> commitizen为什么一定要做成引入package. json…………非js的项目也强制引入的做法也太不科学了……
> 
> JS程序员眼里世上只有一种编程语言么……

不想用package.json 可以选择全局安装

2021年10月15日 15:21 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-430089) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用ckvv的这条留言")

荷兰号 说：

> 引用ChrisZZ的发言：
> 
> 感觉每次给commit分类是个好习惯，但实施起来遇到的困难是，不知道分到哪个type合理。例如要实现的功能是图像的rgb和bgr转换，在arm平台可以利用neon指令加速。那么当我实现了基本版本的转换功能，可以算feat；基于neon新实现了个加速版本的，算feat还是refactor？个人觉得refactor应该是把原有代码覆盖掉，并且有新替代。但优化实现的函数，从对外API角度来看，并没有增加新功能。

feat 是对外API角度来看，有增加新功能

refactor 是对外API角度来看，没有增加新功能  

2021年11月11日 09:01 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-430547) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用荷兰号的这条留言")

HonnaMeiko 说：

阮老师您好，重读旧文，收获不少，但有个疑问在查阅了 angular 规范的文档后还是没有找到相关信息。

我注意到 Commit 中有些会在 Scope 部分加上 `$` 符号，如：

feat($compile):

而有些则不加。请问这是有什么特别的讲究吗？

2021年11月23日 17:34 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-430766) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用HonnaMeiko的这条留言")

Zhengqbbb 说：

各位不妨可以查看我的开源项目： cz-git  
[https://github.com/Zhengqbbb/cz-git](https://github.com/Zhengqbbb/cz-git)  
不懂或者还不了解的可以查看我编写的文档，基本知识点和安装方式都已经涵盖。  
[https://cz-git.qbenben.com/zh/](https://cz-git.qbenben.com/zh/)

2022年4月17日 15:25 | [#](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-433173) | [引用](https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html#comment-text "引用Zhengqbbb的这条留言")

## 我要发表看法

您的留言 （HTML标签部分可用）

您的大名：

 «-必填

电子邮件：

 «-必填，不公开

个人网址：

 «-我信任你，不会填写广告链接

记住个人信息？

## 贡献者

<NolebaseGitContributors />


## 文件历史

<NolebaseGitChangelog />

二叉树

哈希

实用概念

链表

markdown语法

obsidian创建过程

前端

linux

ECMAScript 2015

HTTP 协议、存储、Ajax

异步操作

React Hooks

TypeScript

element ui

vue3

06.js基础

css

手写代码

知识点

问卷

01_系统架构设计

02_功能开发

03_bug排查

Commit message 和 Change log 编写指南

一、Commit message 的作用

2.1 Header

2.2 Body

2.3 Footer

2.4 Revert

三、Commitizen

四、validate-commit-msg

01_系统架构设计

02_功能开发

03_bug排查

Commit message 和 Change log 编写指南 ​

一、Commit message 的作用 ​

2.1 Header ​

2.2 Body ​

2.3 Footer ​

2.4 Revert ​

三、Commitizen ​

四、validate-commit-msg ​

Commit message 和 Change log 编写指南

一、Commit message 的作用

2.1 Header

2.2 Body

2.3 Footer

2.4 Revert

三、Commitizen

四、validate-commit-msg