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
相关推荐
今日无bug1 天前
Git 提交:用全栈技术打造智能 Commit Message 生成器
git·全栈
明月_清风1 天前
拒绝盲目 Git:VS Code 神级插件 GitLens 的 9 个进效杀手锏
前端·git
goodspeed4 天前
Git Worktree:多分支并行开发的利器
git·github
雮尘5 天前
让 AI Agent 高效并行开发的命令-git worktree
人工智能·git·agent
南果梨6 天前
OpenClaw 完整教程!从安装到使用(官方脚本版)
前端·git·开源
Selicens7 天前
git批量删除本地多余分支
前端·git·后端
闲云一鹤8 天前
Git LFS 扫盲教程 - 你不会还在用 Git 管理大文件吧?
前端·git·前端工程化
vibecoding日记11 天前
为什么我就想要「线性历史 + Signed Commits」,GitHub 却把我当猴耍 🤬🎙️
git·编程工具
程序员小崔日记11 天前
如何将代码轻松上传到 Gitee?Git 使用全攻略!
git·gitee·上传