Git 提交规范

git Husky 搭配 commitizen ,规范代码提交 husky可以帮助我们在 执行 git commit 提交的时候,按照eslint 规范进行修复代码。husky是一个git hook工具,可以帮助我们触发git提交的各个阶段:pre-commit、commit-msg、pre-push 支持所有的Git 钩子简单说就是在 Git 执行一些操作时,在钩子处执行一些自己需要的命令。 阅读详情

Git 提交规范主流遵循 Conventional Commits(Angular 规范),用于统一团队协作、自动化生成 CHANGELOG、语义化版本。

一、标准格式(必背)

<type>(<scope>): <subject>

<body>

<footer>
  • Header(必填):type(scope): subject
  • Body(可选):详细说明原因、逻辑、影响
  • Footer(可选):关联 issue、破坏性变更

二、Header 详解

1. type(类型,必填)
  • feat:新功能(feature)
  • fix:修复 bug
  • docs:仅文档变更
  • style:格式/空格/分号,不影响逻辑
  • refactor:重构(无新功能/无 bug 修复)
  • perf:性能优化
  • test:添加/修改测试用例
  • chore:构建/工具/依赖变更
  • revert:回滚提交
2. scope(作用域,可选)

模块/组件/文件名,如:auth、api、ui、order。

3. subject(描述,必填)
  • 祈使句、现在时:add 而非 added、adds
  • 首字母小写,结尾无句号
  • 控制在 50 字符内

三、Body 正文(可选)

  • 空一行后书写,每行≤72 字符
  • 说明为什么改、改了什么、影响范围
  • 可分点(用 - 或 *)

四、Footer 脚注(可选)

  • 关联 Issue:Closes #123 / Fixes #456
  • 破坏性变更:BREAKING CHANGE: 移除旧 API /v1/orders

五、示例最简单常用(工作中 90% 场景)

类型(作用域): 简短描述(动词开头、小写、无句号)


新功能
feat(user): 新增用户头像上传功能
修复 Bug
fix(order): 修复订单列表刷新不更新问题
文档修改
docs(readme): 更新项目启动说明
代码重构(不改功能、不改 Bug)
refactor(auth): 简化登录逻辑代码
样式调整(不影响代码逻辑)
style(button): 修复按钮间距与缩进

fix(标准版:带正文 + 关联 Issue)
fix(pay): 修复微信支付回调签名错误

- 修正签名算法参数顺序
- 增加日志输出便于排查线上问题
- 兼容旧版本回调格式

Closes #108

破坏性变更(标准版)
feat(api): 重构用户信息接口

BREAKING CHANGE: 移除 /api/v1/user 旧接口,使用 /api/v2/user

回滚代码(标准版)
revert: feat(pay): 接入微信支付

This reverts commit abc1234.

GIT 提交说明的规范 GIT 提交说明的规范部分提交代码说明参考Commit Message 的标准格式Header 介绍Body 介绍Footer 介绍提交示例 通过 GIT 提交代码的时候,必须要写提交说明,否则就无法提交 如果我们所有人能够按照一套规范去写提交说明(Commit Message),那我们阅读 Pull Request 的效率就会很高, 参考了 Github 上的开源项目及部分公司的提交规范,总结出以下规范。 规范是所有人默认的一套规定,并不是强制要求,以公司的规范为首要,如果有问题,请留言。。。 部分提交 阅读详情

相关推荐

Git提交规范

最近公司的前端团队分了组,我根据兴趣加入了基础设施建设组,负责做一些方便和规范开发的东西。第一个产出是增加了Git的提交规范,之前参与开源项目时接触到的,感觉很有意思,也很实际,用得到。 参考资料: 阮一峰-Commit message 和 Change log 编写指南 Git提交规范 意义及现状 在开发过程中,Git每次提交代码,都需要写Commit message(提交说明),规...

Creabine的博客 2888

Git规范:Git提交规范

1.Commit message格式 <type>(<scope>):<subject> (1)type(必须) 作用:用于说明Git commit的类别,只允许使用下面的标识。 ① feat:新功能(feature)。 ② fix/to:修复bug,可以是QA(Quality Assurance)发现的BUG,也可以是研发自己发现的BUG。 备注: fix:产生diff并自动修复此问题。适合于一次提交直接修复问题。 to:只产生diff不自动修复此问题

baidu_38300480的博客 6201

【GIT】提交规范

如需在新项目中落地,可以直接复制上述步骤执行,或切换到。这样团队成员 clone 项目后执行。会自动安装 Git Hooks。:直接创建文件即可,内容相同。让我帮你自动化完成。

zywhccyw的博客 585

git提交规范,规范自己的提交标准

为了规范我的git提交内容,提交的时候commit -m “备注的信息”,但是每个人的备注信息千奇百怪,为了统一,我们进行了git的规范。 首先要全局安装commitizen npm i -g commitizen@4.2.4 然后安装插件 npm i cz-customizable@6.3.0 --save-dev 在package.json中添加代码 "config": { "commitizen": { "path": "node_modules/cz-customizable

weixin_44292923的博客 1万+

ParallelsDesktop 安装 CentOS-6.9-x86_64-minimal 教程

安装参考 tools没做 想安装的可以参考这个 mac 本机环境: 系统:macOS Catalina version 10.15.6 虚拟机软件:parallels Desktop 15 for Mac( Parallels Desktop-15.1.4(47270)) Centos镜像: CentOS-6.9-x86_64-minimal.iso https://mirrors.aliyun.com/centos-vault/6.8/isos/x86_64/ http://vault.centos.

爱吃鱼的小明的博客 955

CentOS 7下Oracle 11G RAC静默安装避坑指南:从网络规划到共享存储配置全流程

本文详细介绍了在CentOS 7环境下进行Oracle 11G RAC静默安装的全流程,包括网络规划、共享存储配置和系统参数调优等关键步骤。特别针对静默安装过程中的常见问题提供了实用的避坑指南和优化建议,帮助技术人员高效完成企业级数据库部署。

weixin_29234509的博客 129

笔记——Git Commit 提交规范

在团队协作中,合理的提交规范能够帮助开发者提高代码质量、简化代码审查流程,并促进更高效的团队协作。本文介绍 Git commit 提交规范的重要性,并分享一些最佳实践,帮助开发者更好地管理和记录代码提交。

蜡笔小谢的博客 6737

ROS2节点通信实战:用C++手写一个‘智能小车’控制模型(附完整代码)

本文详细介绍了如何使用ROS2和C++构建一个智能小车控制模型,涵盖运动控制节点、电池管理服务、参数动态配置和Rviz可视化等核心功能。通过实战项目演示ROS2节点通信机制,帮助开发者快速掌握机器人开发的关键技术,并提供了完整的代码实现和系统集成方案。

weixin_30607029的博客 263

【Git】提交规范:怎样让你的提交有意义?

本文将向你展示一个有意义的提交应该是怎样的!

2201_75321755的博客 1537

华硕ROG枪神双系统实战:Ubuntu安装避坑指南

本文是华硕ROG枪神笔记本安装Ubuntu双系统的详细避坑指南。针对其独特的硬件与BIOS设计,文章核心解决了VMD控制器导致硬盘无法识别、驱动兼容性等关键难题,并提供了从BIOS设置、分区方案到安装后驱动配置与性能调优的一站式解决方案,帮助用户实现稳定的双系统体验。

raspberrypi5的博客 546

带隙基准电路实战:温度补偿与流片调优全解析

带隙基准(BGR)是模拟芯片中实现高精度、低温漂电压参考的核心电路,其本质是利用硅材料禁带宽度的物理稳定性,通过PTAT(正温度系数)与CTAT(负温度系数)电压的加权叠加抵消温度影响。原理上需兼顾一阶线性补偿与二阶曲率校正,技术价值在于支撑ADC/DAC/LDO等关键模块的精度与可靠性。典型应用场景涵盖车规级MCU、工业传感器和高精度电源管理芯片。工程落地难点集中于工艺偏差、运放失调、寄生效应及版图热电耦合——这正是‘带隙基准设计’与‘带隙基准调优’的根本分野。本文聚焦真实流片经验,深入拆解Widlar架

weixin_42628280的博客 255

git提交规范

Git提交规范 正式 V1.0 2013-8-24发布 2013-09-01实施 目 录 1. 目的 2. 基本原则 2.1 git个人信息设置 2.2 linux时间设置 2.3 git提交要求 2.4 git提交格式 2...

frame_c的博客 2188

TouchSocket TcpService:构建高性能Tcp服务的终极利器

/ 接收到的数据data");// 回复客户端await ((ITcpSessionClient)client).SendAsync("服务端已收到消息!");// 继续执行后续插件TouchSocket的TCPService以极简的API、强大的扩展性和卓越的性能,重新定义了.NET TCP服务的开发体验。无论是物联网平台还是金融级实时通信系统,TCPService均能提供可靠的基础设施支持。立即探索示例项目,开启你的高性能服务开发之旅!扩展阅读如何实现WebSocket服务?

若汝棋茗 的博客 1461

分享下工作中使用的git提交规范

遇到的问题 版本回退时无法快速定位到指定版本 无法知道项目中封版操作是哪一个commit 无法清晰的知道每次提交的记录 ####以下是commit提交规范 每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。 其中,Header 是必需的,Body 和 Footer 可以省略。 [<type>]: (<scope>): &l...

github_39506988的博客 2万+

【电源专题】Type-C母座外壳直接接主板GND还是接RC呢?别再纠结了!

Type-C屏蔽壳接地这件事,没有唯一标准答案。符合规范、贴合产品、能过认证,就是最优解。希望这篇文章能帮你理清思路。

一点硬件 603

【WRF湿度调整策略】WRF/ERA5湿度数据对比

【WRF湿度调整策略】WRF/ERA5湿度数据对比

WW、forever的博客 121

Git代码提交规范

上一章我们讲解了但是有的同学就问了,那如何规范的提交代码呢?提交信息和整个流程是怎么样的呢?这里我们一起探讨一下工作过程中如何规范git提交代码。这里面我们所有的操作都以代码仓为主仓进行操作。大家先行fork,并拉取代码到本地吧。

Jack魏 3258

STM32F407中文手册

STM32f407中文手册 本参考手册面向应用开发人员,提供有关使用 STM32F405xx/07xx、STM32F415xx/17xx、 STM32F42xxx 和 STM32F43xxx 微控制器存储器与外设的完整信息。STM32F405xx/07xx、STM32F415xx/17xx、STM32F42xxx 和 STM32F43xxx 构成一个微 控制器系列,各产品具有不同的存储器大小、封装和外设。有关订购信息以及器件的机械与电气特性,请参见数据手册。有关 ARM Cortex™-M4F 内核的信息,请参见《Cortex™-M4F 技术参考手册》。

Git 提交信息规范

一、为什么需要制定提交规范? 在团队协作开发时,每个人提交代码时都会写 commit message。 每个人都有自己的书写风格,可以说是五花八门,十分不利于阅读和维护。 一般来说,大厂都有一套的自己的提交规范,尤其是在一些大型开源项目中,commit message 都是十分一致的。 因此,我们需要制定统一标准,促使团队形成一致的代码提交风格,更好的提高工作效率,成为一名有追求的工程师。 二、采...

Orange软件的博客 2650

OV9734 DATASHEET,完整规格书

OV9734完整规格书,包括电气参数,尺寸规格,寄存器配置表等

Camera2Demo

在Camera2 的基础上进行封装,使得Camera2一堆初始化逻辑与Activity分离,降低耦合度,完成预览拍照并保存的操作

Git Commit提交规范总结

团队协作中,规范的Git提交记录,使提交历史明确可追溯,有助于更好的协作,方便后期代码的开发和维护

拾年一剑 的专栏 7416

Git 工程化之提交规范

Git 提供了多种不同类型的钩子(hooks),可以在特定的操作时执行自定义的脚本或命令sql代码解读复制代码。

weixin_47588164的博客 3225

Git提交规范及最佳实践

将价格计算从 ShoppingCartService 移至独立的 PriceCalculator 类,- 修复 tree-shaking 对 lodash 的兼容性问题。❌ 错误:"修复了XXX问题" → ✅ 正确:"修复XXX问题"当用户频繁点击发送验证码按钮时,后端未正确校验时间间隔,revert: 撤销 "feat: 实验性分页功能":描述时用 "新增/修复/优化/调整" 等祈使动词。perf(图片加载): 启用 WebP 格式压缩。fix(登录): 修复手机号验证码重复发送问题。

BillKu的博客 3335

详细的Git 代码提交规范

Git提交规范指南:核心在于通过标准化的提交信息(类型+描述)形成清晰的项目历史。常用类型包括feat(新功能)、fix(bug修复)、docs(文档更新)等,提交信息包含标题、正文和页脚三部分。标题格式为"类型(范围):描述",使用祈使句;正文说明修改原因;页脚标注重大变更或关联Issue。建议保持原子性提交,使用工具辅助规范,并与工作流结合。实际应用中可简化格式,按团队需求调整规范。

念旧的博客 2704

Git代码提交信息规范

git提交代码信息规范

卓越之识论道,平常之识论事,狭隘之识论人 1960
上一篇: LeNet5模型原理讲解-手写代码解析LeNet5模型
下一篇: VGG16模型原理讲解-手写代码解析VGG16模型
王_teacher
博客等级 码龄9年 118粉丝 51原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值