Git 提交模式

news2024/11/23 7:21:05

Git 对我们 Devs 的使用是必不可少的,无论是在个人项目中,还是在多人开源项目或整个社区中。

鉴于此,正确使用 git commit很重要。拥有连贯和标准化的语言有助于参与项目的每个人理解已经发生的变化。

在上图中,我们看到了评论不当的提交有多么有害,因为我们无法理解发生的更改的性质及其上下文。从长远来看,这种影响甚至更具破坏性,因为软件的可维护性由于这些更改范围的不一致以及它们在过去如何影响项目而受到影响。

考虑到这一点,让我们谈谈常规提交模式


它是什么?

Conventional Commits 是提交消息的简单约定,它遵循一组规则并帮助项目拥有明确且结构良好的提交历史记录。


如何使用它?

规则很简单,如下所示,我们有一个提交类型,提交的上下文(范围)和提交的消息(主题)

!type(?scope): !subject
<?body>
<?footer>

因此,!指示强制属性并?指示可选属性。


主题:命令式而不是过去式

通过这种方式,我们告诉我们的团队如果应用提交将做什么。

“如果应用,此提交将会改变”

“If applied, this commit will change the markup”,这比“If applied, this commit will changed the markup”更有意义


类型:提交的类型是什么

类型负责告诉我们正在进行什么更改或迭代,从约定规则来看,我们有以下类型:

  • test:表示任何类型的测试代码创建或更改。
    示例:创建单元测试。

  • feat:表示为项目开发新功能。
    示例:添加服务、功能、端点等。

  • refactor:当存在对系统逻辑/规则没有任何影响的代码重构时使用。
    示例:代码审查后的代码更改

  • style:当代码格式和样式更改不会以任何方式更改系统时使用。
    示例:更改样式指南、更改 lint 约定、修复缩进、删除空格、删除注释等……

  • fix:在纠正在系统中产生错误的错误时使用。
    示例:对未按预期运行并返回错误的函数应用处理。

  • chore:表示对项目的更改不影响系统或测试文件。这些是发展变化。
    示例:更改 eslint 规则 添加 prettier ,向.gitignore添加更多文件扩展名

  • docs:在项目文档中有更改时使用。
    示例:在 API 文档中添加信息,更改 README 等。

  • build:用于指示影响项目构建过程或外部依赖项的更改。
    示例:Gulp、添加/删除npm依赖项等……

  • perf:表示改进系统性能的更改。
    示例:将 ForEach 更改为 While,等等……

  • ci: 用于更改 CI 配置文件。
    示例CircleTravisBrowserStack等……

  • revert: 表示撤销先前的提交。

笔记:

  • 每次提交只有一种 类型;

  • 类型强制性的 ;

  • 如果您不知道要使用哪种类型,则可能是一个很大的更改,并且可以将此提交拆分为两个或更多个提交;

  • build 和 之间的区别 chore 可能非常微妙,并可能导致混淆,因此我们必须知道正确的类型。例如,在 Node.js 的情况下,我们可以认为当存在对某个开发依赖项的添加/更改时 devDependencies,我们使用 chore. 对于项目中常见依赖项的更改/添加,以及对系统有直接和实际影响的,我们使用 build.


范围:上下文化提交

在这一点上——按照过去的约定——我们设法理解了提交中所做的更改类型 (提交类型),并清楚地了解如果应用提交将带来什么(提交主题)

尽管范围不是强制性的,但它可以用于将提交上下文化并减少对主题的责任,使其尽可能简洁明了。请记住, 范围 必须插入括号之间的提交中

注意:作用域必须用/


结论

我写这篇文章是为了记录我的一个学习(它们只是概念应用程序中的一些笔记),但我希望它可以帮助其他开发者。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/193627.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Camtasia2023简体中文版支持4K超清屏幕录屏

Camtasia 2023是TechSmith出品的一款屏幕录像和编辑的软件&#xff0c;可轻松录制和分享高质量的截屏视频&#xff0c;提供所需的工具和功能。功能强大的视频编辑器&#xff0c;通过记录您的屏幕活动和网络摄像头流&#xff0c;帮助您创建具有专业外观的截屏视频。软件提供了强…

“华为杯”研究生数学建模竞赛2005年-【华为杯】B题:空中加油问题的递推模型与调度策略

赛题描述 对飞行中的飞机进行空中加油,可以大大提高飞机的直航能力。为了简化问题,便于讨论,我们作如下假设。 少辅机架数两种情况给出你的作战方案。 论文 摘要 : 本文首先对空中加油问题进行了分析,提取了相关性质,在此基础上 建立了问题的递推模型。根据该模型,文…

使用DcokerCompose部署微服务项目详解

一、项目结构 我这里准备了一个微服务项目。 里面包含三个服务模块&#xff1a; card-service、use-rservice以及网关gateway。 一个公共模块&#xff1a; fegin-api。 其中fegin-api被card-service和user-service引用。 二、基于项目构建部署目录结构 这个springcloud-a…

电子档案备份相对于数据备份的特别之处

最近在和档案馆信息部门领导交流过程中&#xff0c;他们提出了一个很实际的困惑&#xff1a;《“十四五”全国档案事业发展规划》&#xff08;以下简称&#xff1a;《十四五规划》&#xff09;中明确提出了“电子档案备份中心”建设&#xff0c;并且要求“扎实做好档案数字资源…

检索业务:排序和价格区间及库存

排序 点击某个排序时首先按升序显示&#xff0c;再次点击再变为降序&#xff0c;并且还会显示上升或下降箭头 页面排序跳转的思路是通过点击某个按钮时会向其class属性添加/去除desc&#xff0c;并根据属性值进行url拼接 点击排序时 $(".sort_a").click(function () …

如何恢复回收站被清空的文件?你必须要知道的4种方法

电脑回收站里面有很多我们之前删除的文件&#xff0c;如果想要恢复这些文件&#xff0c;直接还原就可以了。但是回收站里面的数据被清空了怎么办&#xff1f;如何恢复回收站被清空的文件&#xff1f;接下来就给大家分享一些恢复回收站文件被删除的方法&#xff01; 方法一、使用…

AcWing 1068. 环形石子合并(环形区间DP)

AcWing 1068. 环形石子合并&#xff08;环形区间DP&#xff09;一、问题二、思路三、代码一、问题 二、思路 在讲解这道题之前&#xff0c;我们需要先掌握线性的区间DP问题&#xff0c;如果对于线性区间DP的解决方式还不了解的话&#xff0c;建议先看一下这篇文章&#xff1a;…

概论第7章_参数估计_点估计的评价标准_相合性_无偏性_有效性

点估计的评价标准包括&#xff1a; 相合性&#xff0c; 无偏性&#xff0c; 有效性。 一. 相合性 衡量一个估计是否可行的必要条件&#xff0c; 就是估计的相合性。 本文不提其定义了。直接给出一些结论。 结论 设有正态总体N(μ,σ2\mu, \sigma^2μ,σ2) 的样本&#xff0c;…

数据结构资料汇编:栈

数据结构资料汇编&#xff1a;栈 定义 栈&#xff08;stack&#xff09;是限定仅在表尾进行插入或删除操作的线性表。 表尾称为栈顶&#xff08;top&#xff09;&#xff0c;可以进行插入或删除操作 栈的插入操作称为进栈或入栈&#xff08;push&#xff09;栈的删除操作成为出…

Google Play 上的 Shady Reward 应用累积了 2000 万次下载

一种新的活动跟踪应用程序类别最近在 Android 的官方应用程序商店 Google Play 上取得了巨大成功&#xff0c;已在超过 2000 万台设备上下载。 这些应用程序将自己宣传为健康、计步器和养成良好习惯的应用程序&#xff0c;承诺为用户在日常生活中保持活跃、达到距离目标等提供…

字节青训前端笔记 | 跨端技术概述

本节课程内容会分为以下几个方面&#xff1a; 跨端是什么&#xff0c;给大家介绍跨端产生的背景及解决的问题跨端技术方案介绍&#xff0c;给大家介绍目前主流的跨端技术方案&#xff08;hybrid 方案/原生渲染方案/自渲染方案/小程序方案&#xff09;以及对比基于小程序跨端实…

苹果或将打造 “空气键盘”

苹果MR头显玩法大揭秘前言苹果MR头显要来了打造 “空气键盘”眼动追踪与手部追踪一键切换VR/AR模式前言 随着2021年10月FaceBook正式改名Meta后&#xff0c;标志着元宇宙元年的正式到来&#xff0c;元宇宙行业开始出现井喷式的爆发。再到2022年10月&#xff0c;“飞天云动”在…

欧科云链链上卫士:2023年1月安全事件盘点

一、基本信息 2023年1月安全事件共造成约1438万美元损失&#xff0c;相比上个月的安全事件损失金额大幅度下降。其中多链项目LendHub 被攻击&#xff0c;损失高达600万美元&#xff0c;为本月资金损失最大的安全事件。本月RugPull数量基本与上月持平。社媒诈骗等事件依然频发&a…

分布式微服务3

目录 Feign远程调用 基于Feign远程调用 Feign替代RestTemplate 1.引入依赖 2.添加注释 3.编写Feign的客户端 4.测试 5.总结 自定义配置 1.引入依赖 2.配置连接池 3.总结 Gateway网关 Gateway快速入门 1.创建gateway服务&#xff0c;引入依赖 2.编写启动类 3.编写…

【微服务】Nacos集群搭建

Nacos集群搭建1.集群结构图2.搭建集群2.1.初始化数据库2.2.下载nacos2.3.配置Nacos2.4.启动2.5.nginx反向代理2.6.优化1.集群结构图 官方给出的Nacos集群图&#xff1a; 其中包含3个nacos节点&#xff0c;然后一个负载均衡器代理3个Nacos。这里负载均衡器可以使用nginx。 我们…

实战:进入Linux系统 紧急模式,重置root密码

实战:进入CentOS 7紧急模式,重置root密码 实战场景:公司的一台CentOS 7系统忘记root密码了,需要快速把root密码修改为 qwer,找回root身份。 (1)重启系统,在出现内核选择界面时(在此界面中,如果不按键盘的上下方向键,则在默认时间过去后,自动选择光标所选的内核并…

题库——“计算机基础”

小雅兰为开学考试而奋斗 模块一 计算机基础概述 &#xff08;1&#xff09;信息技术基本知识 &#xff08;2&#xff09;计算机的发展与应用 &#xff08;3&#xff09;计算机的工作原理 &#xff08;4&#xff09;计算机系统的组成 &#xff08;5&#xff09;微型计算机主要硬…

九龙证券|AIGC彻底火了,概念股全线上涨,走势领先者三连板!

一夜之间&#xff0c;AIGC走红A股&#xff0c;谁会成为商场宠儿&#xff1f; A股历来盛行炒作新体裁&#xff0c;尤其是新体裁诞生的初期&#xff0c;资金参与热心高涨&#xff0c;诞生牛股概率更高。诞生不足两月的ChatGPT便是今年以来最抢手体裁之一&#xff0c;由ChatGPT带动…

Bug:浏览器一直访问旧资源

Bug&#xff1a;浏览器一直访问旧资源 1 问题阐述 今天在查看自己部署的项目时候&#xff0c;发现浏览器总是访问旧的资源 2 排查思路 2.1 浏览器缓存问题 清除浏览器缓存 ctrl shift del2.2 tomcat问题 我的项目是部署在tomcat上的&#xff0c;因此我怀疑是tomcat的配置问…

C语言学习-ProtoThread

一、简介随着RTOS的应用&#xff0c;程序在开发的时候&#xff0c;程序逻辑也变得越来越清晰。但是RTOS因为体量比较大&#xff0c;在一些内存比较小的MCU中无法应用。所以&#xff0c;在裸机的开发中&#xff0c;通常是使用一个while(1)来作为整个程序的大循环。当有条件需要执…