主页

索引

模块索引

搜索页面

2.1.5. Commit 规范

一个好的 Commit Message 至关重要:

1. 可以使自己或者其他开发人员能够清晰地知道每个 commit 的变更内容，方便快速浏览变更历史
    比如可以直接略过文档类型或者格式化类型的代码变更
2. 可以基于这些 Commit Message 进行过滤查找
    比如只查找某个版本新增的功能：
    git log --oneline --grep "^feat|^fix|^perf"
3. 可以基于规范化的 Commit Message 生成 Change Log
4. 可以依据某些类型的 Commit Message 触发构建或者发布流程
    比如当 type 类型为 feat、fix 时我们才触发 CI 流程
5. 确定语义化版本的版本号
    比如:
        fix 类型可以映射为 PATCH 版本
        feat 类型可以映射为 MINOR 版本
        带有 BREAKING CHANGE 的 commit，可以映射为 MAJOR 版本

备注

总结来说，一个好的 Commit Message 规范可以使 Commit Message 的可读性更好，并且可以实现自动化。

Commit Message 的规范:

建议你采用开源社区中比较成熟的规范
例如 jQuery、Angular 等
https://img.zhaoweiguo.com/knowledge/images/soft-engineerings/standard-commit1.webp

社区中的多种 Commit Message 的规范

Angular 规范是一种语义化的提交规范（Semantic Commit Messages），所谓语义化的提交规范包含以下内容:

1. Commit Message 是语义化的
    Commit Message 都会被归为一个有意义的类型，用来说明本次 commit 的类型
2. Commit Message 是规范化的
    Commit Message 遵循预先定义好的规范，比如 Commit Message
    格式固定、都属于某个类型，这些规范不仅可被开发者识别也可以被工具识别
https://img.zhaoweiguo.com/knowledge/images/soft-engineerings/standard-commit2.png

遵循 Angular 规范的 commit 历史记录

在 Angular 规范中，Commit Message 包含三个部分，分别是 Header、Body 和 Footer，格式如下:

<type>[optional scope]: <description>
// 空行
[optional body]
// 空行
[optional footer(s)]

示例:
fix($compile): couple of unit tests for IE9
# Please enter the Commit Message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
# On branch master
# Changes to be committed:
# ...

Older IEs serialize html uppercased, but IE9 does not...
Would be better to expect case insensitive, unfortunately jasmine does
not allow to user regexps for throw expectations.

Closes #392
Breaks foo.bar api, foo.baz should be used instead

Body

备注

Header 对 commit 做了高度概括，可以方便我们查看 Commit Message，Body 中说明了具体做了哪些变更。Body 部分可以分成多行，而且格式也比较自由。此外，它还必须要包括修改的动机，以及和跟上一版本相比的改动点。

示例:

The body is mandatory for all commits except for those of scope "docs".
When the body is required it must be at least 20 characters long.

Revert Commit

备注

除了 Header、Body 和 Footer 这 3 个部分，Commit Message 还有一种特殊情况：如果当前 commit 还原了先前的 commit，则应以 revert: 开头，后跟还原的 commit 的 Header。而且，在 Body 中必须写成 This reverts commit ，其中 hash 是要还原的 commit 的 SHA 标识。

示例:

revert: feat(iam-apiserver): add 'Host' option

This reverts commit 079360c7cfc830ea8a6e13f4c8b8114febc9b48a.

Commit 相关的 3 个重要内容

提交频率

两种情况:

1. 只要我对项目进行了修改，一通过测试就立即 commit
    比如修复完一个 bug、开发完一个小功能，或者开发完一个完整的功能，测试通过后就提交
2. 规定一个时间，定期提交
    这里我建议代码下班前固定提交一次，并且要确保本地未提交的代码，延期不超过 1 天
    这样，如果本地代码丢失，可以尽可能减少丢失的代码量

合并提交

合并提交，就是将多个 commit 合并为一个 commit 提交:

2 种方式提交代码，你可能会觉得代码 commit 比较多，看起来比较随意
想等开发完一个完整的功能之后，放在一个 commit 中一起提交
可以在最后合并代码或者提交 Pull Request 前，执行 git rebase -i 合并之前的所有 commit

修改 Commit Message

有两种修改方法:

1. git commit --amend：修改最近一次 commit 的 message
2. git rebase -i：修改某次 commit 的 message

Commit Message 规范自动化

这些自动化功能可以分为以下 2 类:

1. Commit Message 生成和检查功能:
    a. 生成符合 Angular 规范的 Commit Message
    b. Commit Message 提交前检查
    c. 历史 Commit Message 检查
2. 基于 Commit Message 自动生成 CHANGELOG 和 SemVer 的工具
https://img.zhaoweiguo.com/knowledge/images/soft-engineerings/standard-commit5.webp

围绕着 Commit Message 实现的一些自动化功能

通过下面这 5 个工具自动的完成上面的功能:

1. commitizen-go:
    使你进入交互模式，并根据提示生成 Commit Message，然后提交
    https://github.com/lintingzhen/commitizen-go
2. commit-msg:
    githooks，在 commit-msg 中，指定检查的规则
    commit-msg 是个脚本，可以根据需要自己写脚本实现
3. go-gitlint:
    检查历史提交的 Commit Message 是否符合 Angular 规范，
    可以将该工具添加在 CI 流程中，确保 Commit Message 都是符合规范的
    https://github.com/llorllale/go-gitlint
4. gsemver:
    语义化版本自动生成工具
    https://github.com/arnaud-deprez/gsemver
5. git-chglog:
    根据 Commit Message 生成 CHANGELOG
    https://github.com/git-chglog/git-chglog

实战

pre-commit:

# Copy githook scripts when execute makefile
COPY_GITHOOK:=$(shell cp -f githooks/* .git/hooks/)

参考

主页

索引

模块索引

搜索页面