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
相关推荐
春日见7 小时前
E2E自驾规控30讲:导论
开发语言·驱动开发·git·matlab·计算机外设
__雨夜星辰__9 小时前
什么是 Git 与 Git※hub(※Git※hub加※速访※问教程)
git·github
家里有只小肥猫12 小时前
新项目git推送 删除
git
小码狐13 小时前
GIT相关
git·idea·基础
csdn_aspnet14 小时前
Git贡献全流程拆解:从Fork到PR的完整指南
git·fork·pr
XuDream15 小时前
idea中忽略idea文件不提交git和取消被 Git 追踪
java·git·intellij-idea
0xCode 小新16 小时前
Git常用操作
git·gitee·github
0vvv016 小时前
bugku-web-source(git泄露
git·ctf
Joy T16 小时前
【Web3】告别Remix:基于Hardhat的智能合约工程化构建与实战
git·web3·node·智能合约·hardhat
晨曦蜗牛16 小时前
Windows 上 Claude Code 报错 “requires git-bash“ 的完整解决方案
windows·git·bash