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

git 版本提交规范

Git 提交规范(Git Commit Message Convention)是为了让项目的提交历史更加清晰、可读、便于追踪和自动化工具解析。常见的规范之一是 Conventional Commits,下面是一个推荐的格式规范:


🌟 提交信息格式(Conventional Commits)

<type>(<scope>): <subject>
  • type:提交类型,必填。
  • scope:影响范围(模块、功能、文件名等),可选。
  • subject:简洁的描述(不超过 50 字符),必填,首字母小写,结尾不加句号。

✅ 常用类型(type)

类型描述
feat✨ 新功能、新特性
fix🐛 修复 bug
docs📝 文档修改
style💄 格式(空格、分号等,不影响逻辑)
refactor🔨 重构(即不是新功能也不是修复)
perf⚡ 性能优化
test✅ 增加测试
chore🔧 构建过程或辅助工具的变动
revert⏪ 回退到上一个版本
ci🤖 CI/CD 配置
build🏗️ 构建系统或依赖变动

✍️ 示例

feat(login): 添加用户登录功能fix(api): 修复 getUser 接口返回 500 的问题docs(readme): 更新项目启动说明style: 调整缩进为 4 空格refactor(auth): 优化权限检查逻辑test: 增加 login 模块单元测试chore: 更新 eslint 规则配置

💡 推荐约定

  1. 原子性:每次提交只做一件事。
  2. 简洁明了subject 不要写太长,描述清楚本次变更做了什么。
  3. 英文 vs 中文:团队内部可统一用中文或英文,但建议保持一致。

需要我帮你自动生成 Git 提交模版或者写个脚本规范提交信息吗?

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

相关文章:

  • Linux 网络基础(三) TCP/IP协议
  • AI大模型 —— 国产大模型 —— 华为大模型
  • 卸载工具:IObit Uninstaller Pro v14.3.0 中文绿色专业便携版
  • IO流--字节流详解
  • linux安装mysql数据库
  • 如何下载适用于超宽屏显示的Google Chrome浏览器
  • CMake笔记:find_package工作原理
  • 如何清理Windows系统中已失效或已删除应用的默认打开方式设置
  • 国产DTU!工业DTU“性能翻倍+功耗减半”双突破!
  • 中科院数据生成赋能具身导航!WCGEN:基于世界一致性数据生成的视觉语言导航
  • 退役淘汰的硬盘数据安全处置不可忽视-硬盘数据抹除清零
  • 目标检测:视觉系统中的CNN-Transformer融合网络
  • LeetCode面试经典 150 题(Java题解)
  • c++_csp-j算法 (3)
  • HXBC编译相关错误
  • 【数论】快速幂
  • 用自然语言指令构建机器学习可视化编程流程:InstructPipe 的创新探索
  • 策略模式:思考与解读
  • 记一次 .NET某旅行社酒店管理系统 卡死分析
  • 剑指offer经典题目(五)
  • 数据库管理-第317期 Oracle 12.2打补丁又出问题了(20250421)
  • SAP系统生产跟踪报表入库数异常
  • SSH反向代理
  • C++——STL——容器deque(简单介绍),适配器——stack,queue,priority_queue
  • 23种设计模式-结构型模式之代理模式(Java版本)
  • Fortran 2008标准引入了多项新特性,其中一些对性能有显著影响一些语言新特征
  • C++--负载均衡在线OJ
  • OpenCV 图形API(48)颜色空间转换-----将 LUV 颜色空间的图像数据转换为 BGR 颜色空间函数LUV2BGR()
  • 在Cursor编辑器上部署MCP(Minecraft Coder Pack)完整指南
  • 进程与线程:02 多进程图像