Git 提交规范

Git提交描述格式

# Header头
<type>(<scope>): <subject>

# Body体
<body>

# Footer体
<footer>


# Example:
git commit -m "feat(v1.0.1): new user created API"
git commit -m "fix(v1.0.2): change user API, add fields"

Header头只有一行,包括3个字段: type(必需), scope(可选), subject(必需)

属性 描述
type(必填) commit提交类型
scope(选填) commint提交影响范围
subject(必填) commint提交简短描述

type 提交类型

type说明提交类型：只允许使用下面属性

属性 描述
feat 新功能
fix 修改bug
docs 文档修改
style 格式修改
refactor 重构
perf 性能提升
test 测试
build 构建系统
ci 对CI配置文件修改
chore 修改构建流程、或者增加依赖库、工具
revert 回滚版本
scope 作用范围
  • scope说明提交影响范围：一般是修改的什么模块或者是什么功能，如【xx模块】/【xx功能】
subject 提交主题
  • subject 说明提交简短描述：一般是5-10各自简单描述做的任务，如【xx模块加入消息队列】

2.Body体

body说明提交详细描述：对于功能详细的描述，解释为什么加入这段代码，为什么调整优化等，如因分布式锁问题，导致死锁问题，优化调整xxxx

3.Footer脚

  • Footer脚包括2个字段: Breaking Changes、Closed Issues
属性 描述
Breaking Changes 中断性不兼容变动(不常用)
Closed Issues 关闭Issues问题

  • Breaking Changes
    当前版本与之前版本不兼容，如迭代升级对之前版本不能做到兼容，就需要在Breaking Changes后面描述变动理由和迁移方法之类，此属性不常用

  • Closed Issues
    当前 commit提交针对某个issue问题或者是禅道bug编号等，如Closes # 234

scope 作用范围

scope说明提交影响范围：一般是修改的什么模块或者是什么功能，如【xx模块】/【xx功能】

subject 提交主题

subject 说明提交简短描述：一般是5-10各自简单描述做的任务，如【xx模块加入消息队列】

内容转载：Git提交描述格式规范解析

posted @ 2025-03-07 16:11  二月雪  阅读(73)  评论(0)    收藏  举报