git提交说明可分为三部分,header,body,footer。

Header

header部分包含三个字段,type(必须),scope(可选),subject(必须)

<type>(<scope>): <subject>

type

type用于说明 commit 的性质。

type值 说明
feat 新增功能
fix bug修复
style 代码格式修正(不影响功能)
refactor 代码重构
test 测试
revert 代码回滚
docs 文档变更
perf 改善性能
build 变更项目构建或外部依赖
ci 更新ci配置文件
chore 变更构建流程或辅助工具

scope

scope用于说明 commit 的影响范围。如影响了哪些功能模块或组件。

subject

subject为commit的描述。


Body

代码提交的详细说明。


Footer

如果代码的提交是不兼容变更或关闭缺陷,则Footer必需,否则可以省略。

示例:

<feat>(<test>): test // <type>
// 空一行
just for test // <body>
// 空一行
test //<footer>