Commit规范

67 阅读1分钟

Commit Message格式

每次使用git进行提交时,Commit Message包括三个部分:Header、Body和Footer

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

其中Body和Footer可以省略,而Header是必须的。

Header

(1)type

type用于说明commit类型,可选且只可选以下七种类型:

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动

如果type的值为featfix时,该commit将会出现在Change log当中,其他情况则由个人决定。

(2)scope

scope用于说明commit的影响范围,比如数据层、控制层、视图层等,根据项目架构决定。

(3)subject

subject是commit的简短描述,一般不超过50个字符,且遵循以下规则:

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

Body

body是对本次commit的详细描述,可以分成多行,且遵循以下规则:

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

Footer

footer适用于两种情况:

(1)不兼容变动

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

(2)关闭issue

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

Closes #123, #245, #992