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
相关推荐
KaneLogger10 小时前
OpenCode 操作手册
git
木子小喵10 小时前
通俗讲解Git安装每一步!!
git
IOT那些事儿11 小时前
TortoiseGit拉取开源子仓库失败
git·ssh·tortoisegit·submodule
不想看见40412 小时前
Git的多种仓库选择与推荐
git
脆皮炸鸡75517 小时前
Linux开发工具~~~版本控制器Git以及调试工具GDB
linux·服务器·开发语言·经验分享·git·学习方法
console.log('npc')20 小时前
团队协作提交自己的功能
git
独隅20 小时前
开源项目 Git 贡献全流程的完整拆解:从 Fork 到 PR
git·开源
___波子 Pro Max.1 天前
Git Rebase: HEAD~ 的简洁写法
git
bxri1 天前
团队协作中的 Git 工作流(企业级实战)
git·gitee·github
ljh5746491191 天前
git log source-branch --oneline 命令
git