版本控制系统：Commit messages 的基本语法

无论是个人项目还是在团队协作中，commit message 都应该清晰明了，遵守一定规范。
目前，社区有多种 commit message 的写法规范。本文介绍 Angular规范，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。

当前业界应用的比较广泛的是 Angular Git Commit Guidelines

一、格式化 commit message 的目的

  • 提供更多的历史信息，方便快速浏览。
  • 可以过滤某些 commit（比如文档改动），便于快速查找信息。
  • 可以直接从 commit 生成 Change log。

二、commit message 的格式

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

具体格式为:

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

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，建议是不要。

feat：新增功能（feature）
fix：修复 Bug
docs：用于更新文档、注释或帮助文档。
style：调整代码样式（不影响功能）。如修改命名风格，变量初始化方式等。
refactor：代码重构（不影响功能）。如移动函数位置，拆分代码到不同源码文件等。
test：添加或修改测试代码
ci：与持续集成有关
build：与编译构建相关的变更
revert：恢复之前的提交
perf：性能优化
chore：杂项。与特性或 Bug 无关且不修改 Src 或 Test 文件，如构建过程或辅助工具的变更

 (2) scope

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

(3) subject

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

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

2. Body

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

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) 应该说明代码变动的动机，以及与以前行为的对比。

3. Footer

Footer 部分只用于两种情况。

(1) 不兼容变动

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

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。


Closes #234

也可以一次关闭多个 issue。


Closes #123, #245, #992

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小标题下面。

Commit messages 格式要求

# 标题行：50个字符以内，描述主要变更内容
#
# 主体内容：更详细的说明文本，建议72个字符以内。 需要描述的信息包括:
#
# * 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等
# * 他如何解决这个问题? 具体描述解决问题的步骤
# * 是否存在副作用、风险?
#
# 如果需要的化可以添加一个链接到issue地址或者其它文档

具体案例1

feat($browser): onUrlChange event (popstate/hashchange/polling)
  
Added new event to $browser:
- forward popstate event if available
- forward hashchange event if popstate not available
- do polling when neither popstate nor hashchange available
  
Breaks $browser.onHashChange, which was removed (use onUrlChange instead)

具体案例2

fix($compile): couple of unit tests for IE9
  
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

参考文章：

https://xie.infoq.cn/article/dffa8c4efd68796bc526639ee  Git 提交信息规范化

https://www.cnblogs.com/fei8899/p/14464877.html Git 提交信息规范

***** [GIT] GIT Commit Message 规范 https://www.cnblogs.com/johnnyzen/p/18022473
***** Commit message 和 Change log 编写指南 https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
Git规范详解，让你的代码更专业！ https://baijiahao.baidu.com/s?id=1823122496706886858&wfr=spider&for=pc
版本管理：Git Flow及Commit Message 规范 https://zhuanlan.zhihu.com/p/432381986

  • type(必须) : 用于说明git commit的类别，只允许使用下面的标识。
  • init : 初始化相关(工程、系统)
  • feat : 新功能（feature）
  • fix/to : 修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。
  • fix : 产生diff并自动修复此问题。适合于一次提交直接修复问题
  • to : 只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
  • docs : 文档（documentation）。
  • style : 格式（不影响代码运行的变动）。
  • refactor : 重构（即不是新增功能，也不是修改bug的代码变动）。
  • upgrade/boost/perform : 升级、优化相关，比如提升性能、体验。
  • test : 测试相关
  • chore / cicd / build : 构建过程或辅助工具的变动
  • revert : 回滚到上一个版本。
  • version : (本工程的)版本管理、版本发布、源代码相关（含：依赖组件版本管理）
  • merge : 代码合并。
  • sync : 同步主线或分支的Bug。
  • dependency : 依赖组件的变更
posted @ 2022-09-12 13:13  培轩  阅读(188)  评论(0)    收藏  举报