Skip to content

参考:约定式提交 (conventional commits.org)

Commit Message 包含三个部分

<type>[optional scope]: <description>
// 空行
[optional body]
// 空行
[optional footer(s)]

Header 是必需的,Body 和 Footer 可以省略。在以上规范中,必须用括号 () 括起来, [] 后必须紧跟冒号 ,冒号后必须紧跟空格,2 个空行也是必需的。

Header 部分只有一行,包括三个字段:type(必选)、scope(可选)和 subject(必选)

  • type (必需项)

    标识符描述
    feat新功能(feature)
    fix修复bug
    docs文档变更、文档注释
    style不影响代码内容的修改(格式修改,比如空格、分号、缩进等)
    refactor重构(即不是新增功能,也不是修改bug的代码变动)
    perf提高性能的代码修改
    test添加测试或修正现有的测试
    chore构建过程或辅助工具的变动
    ciCI配置文件和脚本的改动
    revert当前 commit 还原了先前的 commit;revert 后跟还原的 commit 的 Header。而且,在 Body 中必须写成 This reverts commit ,其中 hash 是要还原的 commit 的 SHA 标识
  • scope(可选)

    用于说明 commit 影响的范围,比如比如可以按组件名或者功能,视项目不同而不同。

  • subject(必须项)

    是commit目的的简短描述,不超过50个字符

Body

是对本次commit的详细描述,可分成多行描述