【笔记】Git的约定式提交

发表于 更新于 阅读次数：

前言

Git的约定式提交（Conventional Commits）

提交

1
2
3
4
5
6
feat(api): 某个api新增了一个功能

- 新增功能的描述
- 新增功能的描述

Co-authored-by: 绯鞠 <feiju@loli.fj.cn>

首行

feat：新增功能
fix：修复BUG
build：修改项目构建系统，如：修改依赖、修改运行时版本
chore：修改非业务性代码，如：修改配置
ci：修改持续集成流程，如：修改Jenkins配置
docs：修改文档，如：修改README.md文件
style：修改代码样式，如：调整缩进、调整空行
refactor：重构部分代码，如：修改代码结构但不修改功能
perf：优化性能，如：使用多线程
test：修改测试代码，如：修改Test.java文件

1
feat(api): 某个api新增了一个功能

破坏性提交

  • 通过!强调破坏性提交
1
feat(api)!: 破坏性提交

脚注

Co-authored-by：指定作者
BREAKING CHANGE：指定破坏性提交的描述，如果使用了!可以省略描述脚注

1
Co-authored-by: 绯鞠 <feiju@loli.fj.cn>

完成

参考文献

约定式提交