当前位置: 首页 > 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 提交模版或者写个脚本规范提交信息吗?

相关文章:

  • 软件产品开发全生命周期管理概览:从市场调研到运营维护(着重开发版)
  • 特征提取登上Nature!计算速度为1.0256 TOPS
  • Oracle数据库和PLSQL安装配置
  • C# 的 字符串插值($) 和 逐字字符串(@) 功能
  • .net core 中directory , directoryinfo ,file, fileinfo区别,联系,场景
  • 计算机前沿技术课程论文 K-means算法在图像处理的应用
  • 前端技术未来的发展趋势分析
  • 【Docker 运维】Java 应用在 Docker 容器中启动报错:`unable to allocate file descriptor table`
  • 计组1.2.2——各个硬件的工作原理
  • 永磁同步电机控制算法-VF控制
  • 初识Redis · C++客户端set和zset
  • 创建 Node.js Playwright 项目:从零开始搭建自动化测试环境
  • Web3核心技术解析:从区块链到C++实践
  • 【Linux】进程替换与自定义 Shell:原理与实战
  • 【现代深度学习技术】循环神经网络05:循环神经网络的从零开始实现
  • 电商数据自动化采集方案:淘宝商品详情 API 接入与数据处理技巧
  • 电脑硬盘常见的几种接口类型
  • C++ 操作符重载Operator
  • UofTCTF-2025-web-复现
  • 精益数据分析(11/126):辨别虚荣指标,挖掘数据真价值
  • 空山日落雨初收,来文徵明的画中听泉
  • 国务院国资委:推动央企强化资金统筹,确保及时付款
  • 中央民族乐团团长赵聪已任文旅部艺术司司长
  • 著名政治学学者、中国人民大学教授仝志敏逝世
  • 一季度浙江实现生产总值22300亿元,同比增长6.0%
  • 阿塞拜疆总统阿利耶夫将访华