社区所有版块导航
Python
python开源   Django   Python   DjangoApp   pycharm  
DATA
docker   Elasticsearch  
aigc
aigc   chatgpt  
WEB开发
linux   MongoDB   Redis   DATABASE   NGINX   其他Web框架   web工具   zookeeper   tornado   NoSql   Bootstrap   js   peewee   Git   bottle   IE   MQ   Jquery  
机器学习
机器学习算法  
Python88.com
反馈   公告   社区推广  
产品
短视频  
印度
印度  
Py学习  »  Git

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

芋道源码 • 4 月前 • 188 次点击  

👉 这是一个或许对你有用的社群

🐱 一对一交流/面试小册/简历优化/求职解惑,欢迎加入芋道快速开发平台知识星球。下面是星球提供的部分资料: 

👉这是一个或许对你有用的开源项目

国产 Star 破 10w+ 的开源项目,前端包括管理后台 + 微信小程序,后端支持单体和微服务架构。

功能涵盖 RBAC 权限、SaaS 多租户、数据权限、商城、支付、工作流、大屏报表、微信公众号、CRM 等等功能:

  • Boot 仓库:https://gitee.com/zhijiantianya/ruoyi-vue-pro
  • Cloud 仓库:https://gitee.com/zhijiantianya/yudao-cloud
  • 视频教程:https://doc.iocoder.cn
【国内首批】支持 JDK 21 + SpringBoot 3.2.2、JDK 8 + Spring Boot 2.7.18 双版本 

来源:juejin.cn/post/
7374295163625521161


写在前面

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

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

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

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/ruoyi-vue-pro
  • 视频教程:https://doc.iocoder.cn/video/

git 提交规范

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: 增加用户注册功能

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/yudao-cloud
  • 视频教程:https://doc.iocoder.cn/video/

总结

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

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


欢迎加入我的知识星球,全面提升技术能力。

👉 加入方式,长按”或“扫描”下方二维码噢

星球的内容包括:项目实战、面试招聘、源码解析、学习路线。

文章有帮助的话,在看,转发吧。

谢谢支持哟 (*^__^*)

Python社区是高质量的Python/Django开发社区
本文地址:http://www.python88.com/topic/177124
 
188 次点击