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

常见的 git 提交备注类型

在 Git 提交中,常见的提交备注(commit message)遵循一定的约定,这有助于代码管理、版本控制以及团队协作。fixfeat 是常见的提交类型,下面是这两个的含义,以及其他常见的提交类型。

常见的 Git 提交备注类型

  1. fix: - 修复 Bug
    这个类型的提交通常用于修复某个已知的 Bug 或问题。例如:

     

    text

  • fix: 修复登录时的 null pointer 错误
    
  • feat: - 新增功能
    这个类型的提交表示在项目中增加了一个新功能或新特性。例如:

     

    text

  1. feat: 增加用户权限管理功能
    

其他常见的提交备注类型

  1. docs: - 更新文档
    这个类型的提交用于文档相关的更改,例如更新 README 文件、API 文档等。例如:

     

    text

  • docs: 更新 README 中的安装说明
    
  • style: - 代码风格(不影响功能)
    这个类型的提交仅涉及代码的格式调整,不改变代码的逻辑或功能。例如:

     

    text

  • style: 格式化代码,统一使用 4 个空格缩进
    
  • refactor: - 重构代码(既不修复 Bug 也不增加新功能)
    这个类型的提交表示对代码进行了重构,目的是提高代码质量、可读性或维护性,但不改变代码的外部行为。例如:

     

    text

  • refactor: 优化数据库查询性能
    
  • perf: - 性能优化
    这个类型的提交用于提高代码或系统的性能。例如:

     

    text

  • perf: 优化图片加载速度,减少页面渲染时间
    
  • test: - 测试相关更改
    这个类型的提交用于添加或修改测试代码。例如:

     

    text

  • test: 增加用户登录功能的单元测试
    
  • chore: - 日常任务
    这个类型的提交用于一些日常性任务或杂项更改,通常不影响功能或代码质量。例如:

     

    text

  • chore: 更新依赖包
    
  • ci: - 持续集成相关更改
    这个类型的提交用于更新 CI 配置或相关工具。例如:

     

    text

  • ci: 配置 GitHub Actions 自动化构建
    
  • build: - 构建相关更改
    这个类型的提交用于修改项目的构建系统或外部依赖,例如构建工具、打包配置等。例如:

     

    text

  1. build: 更新 webpack 配置,支持 ES6 编译
    

提交备注的格式化建议

为了使提交信息更加清晰和规范,通常遵循 Conventional Commits 规范。它有如下格式:

 
<type>(<scope>): <message>
  • <type>: 提交类型,如 feat, fix
  • <scope>: 可选的范围,表示本次提交影响的模块或部分
  • <message>: 提交的简短描述,建议使用祈使句,如 "增加新功能" 或 "修复 bug"

示例:

  1. feat(auth): 添加用户注册功能
  2. fix(button): 修复按钮点击无效的问题
  3. chore(deps): 更新 lodash 版本
  4. docs(readme): 修改安装步骤

http://www.kler.cn/a/404900.html

相关文章:

  • 【Xbim+C#】创建圆盘扫掠IfcSweptDiskSolid
  • 7天掌握SQL - 第一天:数据库基础与SQL入门
  • iOS UI 自动化 手势右滑退出当前页面
  • 排序算法:直接插入排序,希尔排序,选择排序,快速排序,堆排序,归并排序
  • 输出比较简介
  • 算法编程题-排序
  • 开源 AI 智能名片 2+1 链动模式商城小程序:场景驱动的商业创新与用户价值挖掘
  • 基于Java Springboot二手商品网站
  • 【Unity3D】获取 GameObject 的完整层级结构
  • 深度学习:如何复现神经网络
  • 99.【C语言】数据结构之二叉树的基本知识
  • Spring MVC 中是如何保证Controller的并发安全?
  • 【unity小技巧】unity 什么是反射?反射的作用?反射的使用场景?反射的缺点?常用的反射操作?反射常见示例
  • C#高级:Winform中的自定义窗体输入
  • 向量数据库FAISS之四:向量检索和 FAISS
  • OpenCV基础(2)
  • React基础知识一
  • P8692 [蓝桥杯 2019 国 C] 数正方形:结论,组合数学
  • 使用ENSP实现静态路由
  • CPU详细介绍
  • Grafana监控PostgreSQL
  • 机器学习系列----关联分析
  • 京东最新黑边背景旋转验证码识别
  • ApiChain 从迭代到项目 接口调试到文档生成单元测试一体化工具
  • Docker+fastapi
  • 2.预备知识