突然发现自己的 commit 记录很乱,就先从添加 类型 开始吧

约定式提交

原网址:中文 | 英文

概述

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

类型

参数 说明
feat 用于表示在代码库中新增了一个功能
fix 用于表示在代码库中修复了一个 bug
refactor 用于重构代码,例如修改代码结构、变量名、函数名等但不修改功能逻辑
docs 用于修改文档,例如修改 README 文件、文档等
style 用于修改代码的样式,例如调整缩进、空格、空行等
chore 用于对非业务性代码进行修改,例如修改构建流程或者工具配置等
perf 用于优化性能,例如提升代码的性能、减少内存占用等
test 用于修改测试用例,例如添加、删除、修改代码的测试用例等
build 用于修改项目构建系统,例如修改依赖库、外部接口或者升级 Node 版本等
ci 用于修改持续集成流程,例如修改 Travis、Jenkins 等工作流配置
  • BREAKING CHANGE<类型>(范围) 后面有一个 ! | 用于表示引入了破坏性 API 变更,破坏性变更可以是任意 类型 提交的一部分。

提交说明的结构

原文:

1
2
3
4
5
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

译文:

1
2
3
4
5
<类型>[可选 范围]: <描述>

[可选 正文]

[可选 脚注]