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
相关推荐
游九尘3 小时前
git只忽略自己本地的文件,其他人的文件正常提交
git
SiYuanFeng4 小时前
新手学Git:以一个小游戏项目为例,完成初始化、提交、查看历史与恢复版本
大数据·git·elasticsearch
rayyy94 小时前
Git 忽略已提交过的文件夹 完整步骤
git
YoseZang4 小时前
【手工】git的使用 - 密钥生成和多账户使用(config文件)
git
韭菜钟4 小时前
Git 代理与内网 Gitea 共存方案(无需 no_proxy)
git·gitea
zhougl9966 小时前
Git 命令速查手册
大数据·git·elasticsearch
小陈同学呦7 小时前
Git Worktree 并行开发实战指南
git·vibecoding
码农小旋风7 小时前
2026 最新 Claude Code Windows 安装教程:Node、Git Bash、命令检查一步步配好
windows·git·bash·claude
ethan.Yin7 小时前
Git_查看已删除文件的历史
git
KieranYin1 天前
Git_查看已删除文件的历史
git