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
相关推荐
向日的葵0063 分钟前
大模型之git操作(第五章)
git
kyriewen5 小时前
我让AI替我写Git提交信息,老板以为我每天工作16小时
前端·javascript·git
難釋懷7 小时前
Redis网络模型-单线程和多线程网络模型变更
网络·redis·git
不做无法实现的梦~7 小时前
Git 新手到团队协作与 GitHub/GitCode 指南
git·github·gitcode
谷哥的小弟8 小时前
(最新版)Git&GitHub实操图文详解教程(02)—安装Git
git·github·安装·配置·下载·图文教程
高斯林.神犇8 小时前
Git远程仓库操作流程
git
谷哥的小弟8 小时前
(最新版)Git&GitHub实操图文详解教程(01)—Git的起源
git·github
小此方8 小时前
Re:Linux系统篇(十四)工具篇 · 五:Git 高效协作实战与“三板斧”秘籍
linux·git·github
拾-光1 天前
【Git】命令大全:从入门到高手,100 个最常用命令速查(2026 版)
java·大数据·人工智能·git·python·elasticsearch·设计模式