约定式提交

1. 基本格式

约定式提交规范是一种基于提交信息的轻量级约定。它提供了一组简单规则来创建清晰的提交历史;这更有利于编写自动化工具。通过在提交信息中描述功能、修复和破坏性变更,使这种惯例与 SemVer在新窗口打开 相互对应。

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

大致分为三个部分(使用空行分割):

  1. 标题行:必填,描述主要修改类型和内容
  2. 主题内容:描述为什么修改,做了什么样的修改,以及开发的思路等等
  3. 页脚注释:放 BREAKING CHANGEClosed Issues

2. 提交的类型

类型内容
feat新功能、新特性
fix修改 Bug
perf更改代码,以提高性能(在不影响代码内部行为的前提下,对程序性能进行优化)
refactor代码重构(重构,在不影响代码内部行为、功能下的代码修改)
docs文档修改
style代码格式修改(例如分号修改)
test测试用例新增、修改
build影响项目构建或依赖项修改
revert恢复上一次提交
ci持续集成相关文件修改
chore其他修改(不在上述类型中的修改)
release发布新版本
workflow工作流相关文件修改

3. 其他部分

部分说明
scopecommit 影响的范围,比如:routecomponentutilsbuild
subjectcommit 的概述
bodycommit 具体修改内容,可以分为多行
footer一些备注,通常是 BREAKING CHANGE 或修复的 Bug 的链接