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

常见的 Commit 描述 分类及示例

在 Git 提交时,清晰、规范的 Commit Message 有助于团队协作和代码维护。以下是常见的 Commit 描述 分类及示例:


1. 功能新增(feat)

适用场景:添加新功能、新模块
格式

feat: 添加用户注册功能  
- 实现手机号+验证码注册  
- 增加注册成功后的跳转逻辑  

常用关键词add, implement, support, introduce


2. 代码优化(refactor/optimize)

适用场景:重构代码、优化性能、减少重复
格式

refactor: 优化订单查询逻辑  
- 使用缓存减少数据库查询  
- 提取重复校验逻辑到 utils/validate  

optimize: 减少重复渲染  
- 使用 React.memo 优化组件性能  
- 合并相似的状态管理逻辑  

常用关键词improve, optimize, simplify, reduce, remove duplicates


3. 问题修复(fix)

适用场景:修复 Bug
格式

fix: 修复登录失效问题  
- 修正 JWT 过期时间计算错误  
- 增加 Token 自动刷新机制  

常用关键词resolve, correct, patch


4. 文档更新(docs)

适用场景:更新 README、注释、API 文档
格式

docs: 更新项目部署指南  
- 添加 Docker 部署步骤  
- 修正错误的 CLI 命令  

常用关键词update, add, revise


5. 测试相关(test)

适用场景:新增或修改测试用例
格式

test: 添加用户登录单元测试  
- 覆盖成功/失败用例  
- 模拟 API 返回异常情况  

常用关键词add, cover, fix, mock


6. 代码风格/格式化(style)

适用场景:调整缩进、空格、分号等(不涉及逻辑)
格式

style: 格式化代码  
- 统一缩进为 2 个空格  
- 移除多余的空行  

常用关键词format, adjust, clean up


7. 依赖更新(chore)

适用场景:升级依赖、调整配置文件
格式

chore: 升级 Vue 到 3.4  
- 更新 package.json  
- 修复兼容性问题  

常用关键词update, bump, migrate


8. 回滚代码(revert)

适用场景:撤销某次提交
格式

revert: 撤销 "feat: 添加支付功能"  
由于第三方 API 不稳定,暂缓上线  

常用关键词rollback, undo


9. 初始化项目(init)

适用场景:项目首次提交
格式

init: 初始化 React 项目  
- 配置 Webpack + ESLint  
- 搭建基础路由结构  

常用关键词setup, scaffold


10. 其他(misc)

适用场景:不适合上述分类的修改
格式

misc: 调整 CI 配置  
- 增加代码覆盖率检查  
- 优化构建缓存策略  

最佳实践

  1. 使用 type: description 格式(如 feat: 新增xx功能
  2. 首字母小写,不加句号(如 fix: 修复登录问题 ✅,Fix: 修复登录问题. ❌)
  3. 正文每行不超过 72 字符,便于 Git 工具查看
  4. 使用 -* 列举关键修改

这样能让团队更清晰地理解每次提交的意图,方便 Code Review 和问题追溯。🚀

http://www.xdnf.cn/news/15415.html

相关文章:

  • 2025-07-15通过边缘线检测图像里的主体有没有出血
  • 2025-07-15 李沐深度学习6——Softmax回归
  • 实测两款效率工具:驾考刷题和证件照处理的免费方案
  • vscode里面怎么配置ssh步骤
  • 算法学习笔记:22.贪心算法之霍夫曼编码 ——从原理到实战,涵盖 LeetCode 与考研 408 例题
  • JavaScript进阶篇——第三章 箭头函数核心
  • 17. 什么是 webSocket ?
  • 面试遇到的问题
  • 项目总体框架(servlet+axios+Mybatis)
  • Qt图形视图框架5-状态机框架
  • 【Python进阶】深度复制——deepcopy
  • 【人工智能】通过 Dify 构建智能助手
  • JavaScript书写基础和基本数据类型
  • 8:从USB摄像头把声音拿出来--ALSA大佬登场!
  • 算法训练营day18 530.二叉搜索树的最小绝对差、501.二叉搜索树中的众数、236. 二叉树的最近公共祖先
  • 迁移学习:知识复用的智能迁移引擎 | 从理论到实践的跨域赋能范式
  • 【前端:Typst】--let关键字的用法
  • 排序树与无序树:数据结构中的有序性探秘
  • 自定义类型 - 联合体与枚举(百度笔试题算法优化)
  • 理解Linux文件系统:从物理存储到统一接口
  • vue3 JavaScript 数据累加 reduce
  • 七、深度学习——RNN
  • 编程语言设计目的与侧重点全解析(主流语言深度总结)
  • 游戏框架笔记
  • 【小白量化智能体】应用5:编写通达信股票交易指标及生成QMT自动交易Python策略程序
  • 控制台打开mysql服务报错解决办法
  • 【STM32】什么在使能寄存器或外设之前必须先打开时钟?
  • 2025js——面试题(8)-http
  • YOLOv11开发流程
  • 为什么资深C++开发者大部分选vector?揭秘背后的硬核性能真相!