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
相关推荐
拼图2095 小时前
Git常用语法
分布式·git·学习
ShineWinsu11 小时前
对于Git:基础操作的超详细保姆级解析
linux·c++·git·面试·备份·管理·版本控制器
沉迷...12 小时前
Git skip-worktree 使用笔记(本地忽略配置文件)
javascript·git
解道Jdon15 小时前
JDK 27发布:紧凑对象头、G1默认、量子安全TLS
ide·windows·git·svn·eclipse·github·visual studio
天天喝旺仔17 小时前
Git 内部原理深度解析:从 blob/tree/commit 对象到 packfile 与垃圾回收
数据结构·数据库·git·算法·哈希
艾莉丝努力练剑17 小时前
【Git:综合复盘】Git 原理与使用
大数据·人工智能·git·elasticsearch·面试
ShineWinsu2 天前
对于Git:远程操作的超详细保姆级解析
linux·git·gitee·github·远程仓库·分布式版本控制系统·远程操作
梦帮科技2 天前
从 Guest 到 Platinum:Prompt 配额、API Key 与访问控制的安全闭环
javascript·git·架构·node.js·reactjs·html5·visual studio
zho_uzhou2 天前
Git入门概念
git
爱奥尼欧3 天前
【Git】远程分支删了本地还在、两个分支历史不相干?两招故障排解
开发语言·git