Git 代码提交规范,feat、fix、chore 都是什么意思

2024-09-19
880 字约 3 分钟
...

Git 代码提交规范,feat、fix、chore 都是什么意思?

经常看到别人提交的代码记录里面包含一些feat、fix、chore等等,而我在提交时也不会区分什么,直接写下提交信息,今天就来看一下怎么个事,就拿 element-plus/ant-design 来看一下。

其实这么写是一种代码提交规范,当然不是为了炫技,主要目的是为了提高提交记录的可读性和自动化处理能力。

当然如果团队没有要求,不这么写也可以。

commit message = subject + :+ 空格 + message 主体

例如: feat:增加用户注册功能

常见的 subject 种类以及含义如下:

  1. feat: 新功能(feature)

    • 用于提交新功能。
    • 例如:feat: 增加用户注册功能
  2. fix: 修复 bug

    • 用于提交 bug 修复。
    • 例如:fix: 修复登录页面崩溃的问题
  3. docs: 文档变更

    • 用于提交仅文档相关的修改。
    • 例如:docs: 更新README文件
  4. style: 代码风格变动(不影响代码逻辑)

    • 用于提交仅格式化、标点符号、空白等不影响代码运行的变更。
    • 例如:style: 删除多余的空行
  5. refactor: 代码重构(既不是新增功能也不是修复bug的代码更改)

    • 用于提交代码重构。
    • 例如:refactor: 重构用户验证逻辑
  6. perf: 性能优化

    • 用于提交提升性能的代码修改。
    • 例如:perf: 优化图片加载速度
  7. test: 添加或修改测试

    • 用于提交测试相关的内容。
    • 例如:test: 增加用户模块的单元测试
  8. chore: 杂项(构建过程或辅助工具的变动)

    • 用于提交构建过程、辅助工具等相关的内容修改。
    • 例如:chore: 更新依赖库
  9. build: 构建系统或外部依赖项的变更

    • 用于提交影响构建系统的更改。
    • 例如:build: 升级webpack到版本5
  10. ci: 持续集成配置的变更

*   用于提交CI配置文件和脚本的修改。
*   例如:`ci: 修改GitHub Actions配置文件`

11. revert: 回滚

*   用于提交回滚之前的提交。
*   例如:`revert: 回滚feat: 增加用户注册功能`

使用规范的提交消息可以让项目更加模块化、易于维护和理解,同时也便于自动化工具(如发布工具或 Changelog 生成器)解析和处理提交记录。

通过编写符合规范的提交消息,可以让团队和协作者更好地理解项目的变更历史和版本控制,从而提高代码维护效率和质量。

如果您觉得这篇文章有帮助,请点个赞吧~

分享文章

相关文章

更多文章 →
git2025-07-21
git之代码提交错误解决
我 add 错误文件了,怎么办? 这个就比较简单了,执行 该命令的作用是: 撤销暂存 :所有已经 的文件会变成未暂存状态。 保留工作区的修改 :文件内容保持不变,仍然在工作区。你可以继续提交文件或者做一些修改之后再提交文件。 我不但 add 了还 commit 了,怎么办? 只能说你还没推送,还行!!! 其实也不难,执行一下 其中的HEAD 1是将 (当前分支的最新提交)回退到 前一个提交 ( 表示“当前提交的前一个”)。 如果你做了两...
学习
git2025-07-04
Git 移除已追踪文件/文件夹
<span style="color: var( g textcolor);" 详解如何优雅地从 Git 仓库中移除已被追踪的文件,并介绍相关的最佳实践和注意事项。</span 问题背景 在项目开发中,经常会遇到一些不应该被 Git 追踪的文件被意外提交的情况,比如: IDE 配置文件(.vscode、.idea 等) 编译生成的文件夹(node modules、dist 等) 本地配置文件 日志文件 解决步骤 1\. 创建或更新 .g...
学习
git2024-09-23
Git stash命令详解和使用
&nbsp; stash 命令使用非常简单,是经常使用的命令 应用场景: 1 、临时存储已修改的代码:比如正在分支A上开发某个功能,还未完成,突然要切换到B分支上去修复一个bug。这时就可以用git sta 将本地修改的内容保存至堆栈区,再切换到B分支修改bug,修复完成后,再切回到A分支,从堆栈中恢复刚刚保存的内容。 2 、同步代码:由于不小心,本来要在A分支上开发的功能代码,却写在了B分支上,这时就可以用git stash将本地代码...
学习
git2024-02-23
Git Worktree 的使用
官方介绍地址: 对于 git worktree 的使用场景,我们举个例子说明。 如果我们正在进行重构代码,老板突然要求我们立即修复某些问题。通常我们可能会使用 git stash 来临时存储相关更改,但是此时工作树会处于这样一种混乱状态(有新增的、被移动的、被删除的文件,以及其他的修改)。一个不注意,我们就会打乱 git stash 中的文件,此时我们原本的修改或者 Git 管理有可能就会出现问题。 如果我们希望在不影响现有更改的前提下...
学习
http-网络2026-10-15
OAuth 2.0是什么,以及如何正确接入
一、先从一个需求理解 OAuth 2.0 假设你开发了一个相册整理工具,用户希望它读取某个云盘里的照片。 把云盘密码交给工具,会带来几个问题:工具拿到的权限太大,密码可能泄漏,用户也难以只撤销这个工具的访问。 OAuth 2.0 提供一套 委托授权机制 :用户在云盘自己的页面确认授权,工具取得一个有权限范围和有效期的访问令牌,再用它调用云盘 API。用户的云盘密码不交给工具。 可以把它理解为:给工具一张“限定用途的通行证”。但令牌泄漏同...
学习
前端2026-10-15
前端动画全景指南
一、前端动画到底是什么 前端动画,就是让画面随时间、用户输入或页面状态连续变化。变化的对象可以是按钮的位置、弹窗的透明度、SVG 的线条、Canvas 里的粒子,也可以是三维场景中的镜头。 先把三个问题分开: | 问题 | 常见答案 | | | | | 画什么? | DOM/CSS、SVG、Canvas 2D、GPU 渲染的场景、预制动画素材 | | 怎样变化? | CSS 过渡/关键帧、Web Animations API、逐帧计算、...
学习

评论

请登录后发表评论

去登录
加载评论中...