Git Commit Specification (GIT提交规范)

Git Commit Specification (GIT提交规范)

参考：

阮一峰：Commit message和Change log编写指南

推荐使用SourceTree来管理。

Windows/Mac OS X版本下载：Sourcetree官网

Commit message 格式

每次提交，Commit message 都包括三个部分：header，body 和 footer。

1
2
3
4
5
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

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

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

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

type

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

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

scope

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

如果你的修改影响了不止一个scope，你可以使用*代替。

subject

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

其他注意事项：

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

Body

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

1
2
3
4
5
6
7
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

注意：

  • 使用第一人称现在时，比如使用change而不是changed或changes。
  • 永远别忘了第2行是空行
  • 应该说明代码变动的动机，以及与以前行为的对比。

Foot而部分只用以下两种情况：

不兼容变动

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

关闭Issue/缺陷

1
Close #I1LBF8

关闭多个用将ID用逗号+一个空格分开,

Revert

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

1
2
3
revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

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

技术 > Git
#Git
Git Commit Specification (GIT提交规范)
https://www.shaohang.xin/2020/06/22/technical/git/git-commit-specification/
作者
少航
发布于
2020年6月22日
许可协议