当前位置: 首页 > news >正文

关于Git仓库提交规范说明

1.前言

在初学者使用 Git 提交代码时,往往会出现提交信息随意、语义不清的问题。这种方式在项目初期影响不大,但随着项目规模扩大,会导致提交历史难以追溯、问题定位困难、协作成本增加。

常见的 Git 仓库提交规范主要是为了让提交历史清晰、可读、可维护。业界最常用的一套是Conventional Commits(约定式提交),很多团队也会在此基础上做轻微定制。本文浅尝辄止地讲解一下代码提交的基本规范,以帮助快速上手Git这个强大的版本管理工具。

Conventional Commits官方网站:


Conventional Commits

2.提交信息基本结构

<type>(optional scope): <subject>

[optional body]

[optional footer]

3.type(提交类型)

最核心的一部分,用来说明这次提交的性质:

类型含义
feat新功能
fix修复 bug
docs文档变更
style格式调整(不影响代码逻辑)
refactor重构(既不是新功能也不是修复)
perf性能优化
test测试相关
chore构建/工具/依赖变更
ciCI/CD 相关
build构建系统或依赖变更
revert回滚

4.optional scope(可选)

表示影响范围(模块/功能):

feat(auth): 登录支持验证码
fix(api): 修复用户接口报错

5.subject(提交标题)

规范:

  • 使用动词开头
  • 使用现在时
  • 不超过 50 字符
  • 不加句号

示例:

feat: 添加用户注册功能
fix: 修复登录状态丢失问题

6.body(可选详细说明)

用于解释“为什么改”,而不是“改了什么”

示例:

fix: 修复支付重复提交问题

由于前端未做防抖处理,用户快速点击会导致重复请求,
在服务端增加幂等性校验。

7.footer(可选)

用于:

1. 关联 issue

Closes #123

2. BREAKING CHANGE(重大变更)

BREAKING CHANGE: 登录接口返回结构已修改

8.完整示例

feat(user): 增加用户头像上传功能

支持 jpg/png 格式,限制大小为 2MB,
并接入对象存储服务。

Closes #45

http://www.jsqmd.com/news/696335/

相关文章:

  • 嵌入式系统最后防线:在无MMU的MCU上实现C语言内存安全的3种硬件协同方案(ARMv8-M TrustZone实测)
  • 从安全开关到电机转动:图解APM/Pixhawk飞控的完整解锁信号链与硬件接线
  • AI临终关怀师职责:软件测试从业者的专业视角
  • Flutter 翻页动画:前后翻页实现
  • 2026双干燥机厂家标杆名录:闪蒸干燥机、圆盘干燥机、带式干燥机、桨叶干燥机、滚筒干燥机、真空干燥机、耙式干燥机选择指南 - 优质品牌商家
  • Linux SSH免密登录实验:基于Xshell的公钥认证机制
  • 2026年热门的自动化控制柜厂家哪家好?自动化控制柜/充气柜/光伏并网柜厂家推荐 - 栗子测评
  • 别再折腾MCP2515了!手把手教你用ESP32内置TWAI外设实现CAN通信(附完整代码与500K波特率避坑指南)
  • SpringBoot+Vue炼油厂盲板管理系统源码+论文
  • STM32F407驱动RDA5820N模块:从数据手册到可用的C语言库(I2C通信详解)
  • LoRA微调Stable Diffusion:高效定制AI图像生成
  • 不只是压缩:当模型蒸馏开始复制人格
  • 2026年知名的超低温蝶阀/空分蝶阀公司选择指南 - 品牌宣传支持者
  • 量子KIC模型与量子电池:理论与精确对角化技术
  • Django ORM 中的 Many-to-Many 关系处理
  • 终极指南:如何在iOS设备上快速安装TrollStore的完整解决方案
  • 洛谷题解:P16273 [蓝桥杯 2026 省 Java B 组] 回程
  • STM32F103/CH32F103定时器单脉冲模式在可控硅过零触发中的实战应用
  • GPT-5.5 战略转移:OpenAI 不再做聊天机器人了
  • 计算机网络复习(第三章):数据链路层
  • Windows 10/11 右键菜单找回经典CMD:修改注册表一键恢复“在此处打开命令窗口”
  • Phi-mini-MoE-instruct镜像优势:预装transformers+gradio+supervisor,免apt-get折腾
  • 罗技鼠标宏压枪:告别手抖,让PUBG射击更稳定的终极指南
  • chatgptimage2.0手机版app下载安装教程gptimage2.0手机版下载安装教程安卓版app鸿蒙版苹果版IOS电脑版安装包下载地址
  • 新药研发避坑指南:如何用ADMET预测工具(如ADMETlab 2.0)提前筛掉“问题分子”?
  • C语言01
  • 若依RuoYi-Vue项目接入第三方系统?手把手教你实现SSO单点登录(附完整代码)
  • 算法训练营第十二天 | 多数元素
  • Hutool JWT 教程
  • Python数据类型转换实现方法