约定式提交
1. 基本格式
约定式提交
可阅读 约定式提交中文文档。
约定式提交规范是一种基于提交信息的轻量级约定。它提供了一组简单规则来创建清晰的提交历史;这更有利于编写自动化工具。通过在提交信息中描述功能、修复和破坏性变更,使这种惯例与 SemVer 相互对应。
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
大致分为三个部分(使用空行分割):
- 标题行:必填,描述主要修改类型和内容
- 主题内容:描述为什么修改,做了什么样的修改,以及开发的思路等等
- 页脚注释:放 BREAKING CHANGE 或 Closed Issues
2. 提交的类型
类型 | 内容 |
---|---|
feat | 新功能、新特性 |
fix | 修改 Bug |
perf | 更改代码,以提高性能(在不影响代码内部行为的前提下,对程序性能进行优化) |
refactor | 代码重构(重构,在不影响代码内部行为、功能下的代码修改) |
docs | 文档修改 |
style | 代码格式修改(例如分号修改) |
test | 测试用例新增、修改 |
build | 影响项目构建或依赖项修改 |
revert | 恢复上一次提交 |
ci | 持续集成相关文件修改 |
chore | 其他修改(不在上述类型中的修改) |
release | 发布新版本 |
workflow | 工作流相关文件修改 |
3. 其他部分
部分 | 说明 |
---|---|
scope | commit 影响的范围,比如:route 、component 、utils 、build 等 |
subject | commit 的概述 |
body | commit 具体修改内容,可以分为多行 |
footer | 一些备注,通常是 BREAKING CHANGE 或修复的 Bug 的链接 |