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
相关推荐
七分辣度5 小时前
GitHub/Git 常用命令及使用场景
git·github
慧都小项1 天前
MyEclipse Inline Diff 实用指南:逐处核对 AI 修改再提交
git·ai编程·myeclipse·java 代码审查·ai 代码修改
德育处主任1 天前
让 Claude Code 在你睡觉时接着干活:tmux、权限策略与验收清单
git·ai编程·命令行
为思念酝酿的痛4 天前
Git基本操作
git·github
wno7045 天前
常用的Git命令清单
大数据·git·elasticsearch
真上帝的左手5 天前
3. 代码管理-Git-进阶
git·源代码管理
YIN_尹5 天前
【git原理与使用】git基本操作及底层原理(二)
大数据·git·elasticsearch
程序员爱德华6 天前
Git 命令
git
Cry丶6 天前
Git Rebase 操作备忘
git·rebase
你叶不叶6 天前
abap git 如何从 gitee上在线拉取数据(上一步已经配置好证书)
git·gitee·sap·abapgit