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

​​Git提交代码Commit消息企业级规范

​Git Commit 类型完整指南​

类型用途示例
feat新增功能(面向用户的功能性变更)git commit -m "feat: 添加用户登录功能"
fix修复 Bug(解决代码中的问题)git commit -m "fix: 修复首页加载崩溃问题"
docs文档更新(README、注释等)git commit -m "docs: 更新 API 接口文档"
style代码样式调整(空格、格式化、分号等,​​不改变逻辑​​)git commit -m "style: 调整缩进为 2 空格"
refactor代码重构(优化结构但无功能变化)git commit -m "refactor: 提取支付逻辑到独立模块"
perf性能优化(提升执行效率)git commit -m "perf: 减少首屏渲染时间 200ms"
test测试用例(单元测试、E2E 测试)git commit -m "test: 添加用户注册流程测试"
build构建工具或依赖变更(Webpack、npm 等)git commit -m "build: 升级 Vue 到 3.2"
ciCI/CD 配置变更(GitHub Actions、Docker 等)git commit -m "ci: 添加自动化部署流程"
chore杂项任务(非代码/文档的改动,如更新脚本)git commit -m "chore: 更新依赖版本"
revert回滚之前的提交git commit -m "revert: 撤销某次错误的合并"

​进阶用法​

1. ​​添加范围(Scope)​

指定影响的范围(模块、组件、文件等):

git commit -m "feat(login): 添加短信验证码登录"
git commit -m "fix(router): 修复路由重定向循环问题"
2. ​​多行提交消息​

复杂变更可使用多行描述(第一行是摘要,空一行后写详情):

git commit -m "feat: 支持暗黑模式
>
> - 新增主题切换组件
> - 添加全局样式变量
> - 适配所有页面组件"
3. ​​关联 Issue​

在消息中引用问题跟踪(如 GitHub Issue):

git commit -m "fix: 解决滑动卡顿问题 (close #123)"

​为什么需要规范?​

  1. ​自动化生成 CHANGELOG​​(通过工具如 standard-version)。
  2. ​清晰的历史记录​​:快速定位特定类型的变更。
  3. ​触发语义化版本号(SemVer)​​:
    • feat → 次版本号 v1.2.0
    • fix → 修订号 v1.2.1
    • BREAKING CHANGE → 主版本号 v2.0.0

​常见问题​

Q:拼写错误怎么办?
  • 使用 git commit --amend 修改最后一次提交:
    git commit --amend -m "feat: 正确的提交消息"
    
Q:如何绕过 Husky 检查?
  • 添加 --no-verify(仅紧急情况下使用):
    git commit -m "xxx" --no-verify
    

​工具推荐​

  • ​Commitizen​​:交互式生成合规的提交消息
    npx cz
    
  • ​Commitlint​​:检查提交消息格式(你项目已配置)

规范提交消息能让团队协作更高效!

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

相关文章:

  • mongodb生产备份工具PBM
  • 学习设计模式《十五》——模板方法模式
  • SpringBoot 防刷 重复提交问题 重复点击问题 注解 RequestParam RequestBody
  • clion与keil分别配置项目宏定义
  • Python打卡:Day39
  • MySQL 连接指定端口后,为什么实际仍是 3306?
  • 什么是故障注入测试
  • 智能助手(利用GPT搭建智能系统)
  • 性能测试常见指标与瓶颈分析方法
  • 利用python实现NBA数据可视化
  • Python Selenium 滚动到特定元素
  • 10【认识文件系统】
  • 视觉疲劳检测如何优化智能驾驶的险情管理
  • 【RAG面试题】LLMs已经具备了较强能力,存在哪些不足点?
  • 【k近邻】 K-Nearest Neighbors算法原理及流程
  • 《高等数学》(同济大学·第7版)第九章 多元函数微分法及其应用第五节多元函数微分学的几何应用
  • 桌面小屏幕实战课程:DesktopScreen 13 HTTP SERVER
  • [Python]-基础篇1- 从零开始的Python入门指南
  • Python打卡:Day38
  • .NetCore+Vue快速生产框架开发详细方案
  • 深入解析RNN模型:应用、结构与构建实战
  • C++ 第三阶段 并发与异步 - 第二节:异步任务(std::async)
  • 深度拆解Deep Research系统架构与路线图
  • MySQL在C中常用的API接口
  • Linux信号机制:从入门到精通
  • Java项目:基于SSM框架实现的宠物综合服务平台管理系统【ssm+B/S架构+源码+数据库+毕业论文+开题报告】
  • 【记录】Ubuntu|Ubuntu服务器挂载新的硬盘的流程(开机自动挂载)
  • 动手学Python:从零开始构建一个“文字冒险游戏”
  • 2025.6.27总结
  • react-sequence-diagram时序图组件