如何规范你的Git commit？

优化建议
#1

导读：commit message应该如何写才更清晰明了？团队开发中有没有遇到过让人头疼的git commit？本文分享在git commit规范建设上的实践，规定了commit message的格式，并通过webhook在提交时进行监控，避免不规范的代码提交。

背景

Git每次提交代码都需要写commit message，否则就不允许提交。一般来说，commit message应该清晰明了，说明本次提交的目的，具体做了什么操作……但是在日常开发中，大家的commit message千奇百怪，中英文混合使用、fix bug等各种笼统的message司空见怪，这就导致后续代码维护成本特别大，有时自己都不知道自己的fix bug修改的是什么问题。基于以上这些问题，我们希望通过某种方式来监控用户的git commit message，让规范更好的服务于质量，提高大家的研发效率。

规范建设

Angular规范是目前使用最广的写法，比较合理和系统化，并且有配套的工具（IDEA就有插件支持这种写法）。

commit message格式

Commit message 都包括三个部分：Header，Body 和 Footer

只包含 Header 的简要 git commit message 格式：

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

完整的 git commit message 格式：

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

<body>

<footer>

Header

type(必须)

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

  • feat：新功能（feature）。
  • fix/to：修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。
    • fix：产生diff并自动修复此问题。适合于一次提交直接修复问题
    • to：只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
  • docs：文档（documentation）。
  • style：格式（不影响代码运行的变动）。
  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）。
  • perf：优化相关，比如提升性能、体验。
  • test：增加测试。
  • chore：构建过程或辅助工具的变动。
  • revert：回滚到上一个版本。
  • merge：代码合并。
  • sync：同步主线或分支的Bug。

scope(可选)

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

例如在Angular，可以是location，browser，compile，rootScope， ngHref，ngClick，ngView等。在后端项目中，一般是数据层（data）、业务层（service）、控制层（ctrl）、视图层（view）等等，视项目不同而不同。如果你的修改影响了不止一个scope，你可以使用*代替。

subject(必须)

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

  • 建议使用中文（感觉中国人用中文描述问题能更清楚一些）。
  • 结尾不加句号或其他标点符号。
  • 根据以上规范git commit message将是如下的格式：
fix(DAO):用户查询缺少username属性 
feat(Controller):用户查询接口开发

Body

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.

注意：

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

Footer

Footer 部分只用于两种情况。

（1）不兼容变动

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

（2）关闭 Issue

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

Closes #234

也可以一次关闭多个 issue

Closes #123, #245, #992

Revert

如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。

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

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

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

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

以上就是我们梳理的git commit规范，那么我们这样规范git commit到底有哪些好处呢？

  • 便于程序员对提交历史进行追溯，了解发生了什么情况。
  • 一旦约束了commit message，意味着我们将慎重的进行每一次提交，不能再一股脑的把各种各样的改动都放在一个git commit里面，这样一来整个代码改动的历史也将更加清晰。
  • 格式化的commit message才可以用于自动化输出Change log。