Git commit提交规范

引言

使用git管理代码的同行,我们经常能看到其他人代码提交时的备注写的过长,有的看不懂,有的太过间接,本文旨在简单说明git commit提交的规范,规范提交内容。

git commit template

提交格式<type>(<scope>): <subject>

格式对应说<commit类型>(影响范围可选): 具体描述

举例 fix(DAO): 修复xxBug。

type

|--------------|---------------------------|
| 类型 | 说明 |
| feat | 新功能 |
| fix | 修补bug |
| docs | 文档 |
| style | 格式(不影响代码运行的变动) |
| refactor | 重构(即不是新增功能,也不是修改bug的代码变动) |
| test | 增加测试 |
| chore | 构建过程或辅助工具的变动 |
| perf | 性能优化 |
| build | 打包 |
| ci | 持续集成 |

scope(可选)

scope用于说明 commit 影响的范围,根据不同项目有不同层次描述。若没有特殊规定,也可以描述影响的哪些功能等。

subject

subject是 commit 目的的简短描述,不超过50个字符。

  • 以动词开头,使用第一人称现在时,比如change
  • 结尾不加标点符号
  • 第一个字母小写

栗子

sql 复制代码
fix(mybatis):修复sql查询bug
相关推荐
森叶28 分钟前
Git flow command error: ‘flow‘ is not a git command 问题解决
git
天麓2 小时前
git merge 举例
git
AI_56783 小时前
Git冲突治理白皮书:智能标记与可视化协同的下一代解决方案
大数据·人工智能·git·机器学习
念丶小宇3 小时前
Git常用指令
大数据·git·elasticsearch
CSDN_RTKLIB4 小时前
Git Clone
git
中二病码农不会遇见C++学姐4 小时前
.env 文件是干啥的?为什么不能提交到 Git?
git·学习
CoderJia程序员甲5 小时前
GitHub 热榜项目 - 日榜(2026-02-03)
git·ai·开源·llm·github
宴之敖者、5 小时前
Linux——git和gdb
linux·运维·git
辰风沐阳6 小时前
git 忽略大小写(重命名文件)
大数据·git·elasticsearch
天麓6 小时前
git rebase 举例
git