git commit 提交规范

128 阅读1分钟

为什么需要定制提交规范

在团队协作开发时,每个人提交代码时都会写 commit message。
每个人都有自己的书写风格,翻看我们组的git log, 可以说是五花八门,十分不利于阅读和维护。
这时拥有一套代码提交规范就显得非常重要了,促使团队形成一致的代码提交风格,更好的提高工作效率,成为一名有追求的工程师。

制定适合我们的git commit 提交规范

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

<type>: <description>
(空行)
<body>
(空行)
<footer>

其中,Header是必需的,Body和Footer可以忽略。

Header

Header部分只有一行,包括三个字段:type(必需)和description(必须)。

1.type(类型)

type是commit的类别,只允许如下几种标识

  • feat: 添加新功能
  • fix: 修复bug
  • docs: 文档变更
  • ui: 页面UI更新
  • style: 不影响程序的代码修改(修改空白字符串,格式缩进,补全缺失分号,更改文案等,没有改变代码逻辑)
  • test: 新增测试用例或更新现有测试
  • chore: 其它修正,比如修改构建系统,版本号修正,更改配置文件等
  • revert: 回滚某个更早之前的版本

2.description(描述)

description是commit目的的简短描述

Body(选填)

Body主要是对本次commit的详细描述

Footer(选填)

Footer部分只用于两种情况

  • 不兼容变动(当前代码与上一个版本不兼容)
  • 关闭 Issue (如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。)