当前位置: 首页 > 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​​:检查提交消息格式(你项目已配置)

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

相关文章:

  • Qwen VLo :一个多模态统一理解与生成模型
  • PICkit3编程器MCLR引脚全解析
  • 汇总表支持表头分组,查询组件查询框可以调整高度,DataEase开源BI工具v2.10.11 LTS版本发布
  • 面向对象Plus(2/2)
  • 鸿蒙 SideBarContainer 开发攻略:侧边栏交互设计与多端适配
  • 设计在线教育项目核心数据库表
  • 2024百度之星:BD202404 110串
  • 判定表测试
  • Django ORM 1. 创建模型(Model)
  • yaml 导致的原型污染 -- GPN CTF 2025 Secure by Default
  • 基于51单片机-蜂鸣器演奏《飞雪玉花》
  • 编译原理---文法和语法分析
  • 利用python实现NBA数据可视化
  • SpringBoot 防刷 重复提交问题 重复点击问题 注解 RequestParam RequestBody
  • 《高等数学》(同济大学·第7版)第九章 多元函数微分法及其应用第五节多元函数微分学的几何应用
  • 6.27_JAVA_面试(被抽到了)
  • OpenLayers 渲染之矢量影像图层
  • 10【认识文件系统】
  • 【机器学习深度学习】线性回归(基本模型训练流程)
  • 【BugkuCTF】overflow