commit 信息风格迥异、难以阅读,如何规范?

大家好!最近很长时间没有更新了,由于加入新团队新的项目组参与新的工作,导致博客创造搁置了一段时间,今天来记录一下我最近学习到的规范。

怎么写出符合 Angular 规范的 Commit Message 呢?

这是我们团队规定的规范。主要元素如下图所示

当我在开发过程中变更了应用代码,比如某个 Go 函数代码,那这次的修改属于代码类。在代码类
中,有 4 种具有明确变更意图的类型:feat、fix、perf 和 style;如果我们的代码变更不
属于这 4 类,那就全都归为 refactor 类,也就是优化代码。Angular 的 Commit Message 规范提供了大部分的 type,在实际开发中,我们可以使用
部分 type,或者扩展添加我们自己的 type。但无论选择哪种方式,我们一定要保证一个项
目中的 type 类型一致。

举一个我最近提交代码的例子吧!

feat(authentication): add JWT token authenticationAdd JWT token authentication feature to improve security for user login process.

在这个示例中:

  • feat 表示这是一个新特性的提交。
  • (authentication) 是指该提交涉及到的功能模块或者部分,这里是认证部分。
  • add JWT token authentication 是对这次提交所做的具体描述,清晰地说明了新增的功能。

按照 Angular 规范,提交信息的格式通常为:

<type>(<scope>): <subject>
  • <type> 表示提交的类型,可以是 featfixdocs 等。
  • <scope> 是可选的,表示这次提交影响到的范围或者模块。
  • <subject> 是提交的简要描述,描述了这次提交所做的具体变更。

这种格式的提交信息使得代码库的提交历史更加清晰可读,并且有助于团队成员快速理解每次变更的目的和影响。

好了,以上就是我最近在团队开发中学习到的开发规范,经过这段时间的磨砺,提升了自己真正的开发经验,能够高效配合团队开发出优秀的代码。

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

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

把持中国互联网流量的“四大家族”,各个牛逼plus!

中国互联网80%流量被四大家族把持着&#xff0c;其余要么去这些家族批发流量&#xff0c;要么去抢占剩余20%。 以下是对中国互联网流量四大家族的介绍和代表性的流量入口产品&#xff1a; 百度系&#xff1a; 百度是中国最大的搜索引擎公司&#xff0c;其搜索引擎百度是中国互…

办公小助手来啦! Textin接口,轻松提取文件信息,让你如虎添翼!

&#x1f60e;大家是不是经常为了一堆文件而头疼呢&#xff1f;&#x1f4da;别担心&#xff0c;Textin接口它来了&#xff01;&#x1f389; 一、Textin的神秘面纱 1. Textin是谁&#xff1f; &#x1f50d;Textin接口&#xff0c;一款专业的文件信息提取工具&#xff0c;只…

蓝桥杯嵌入式(G431)备赛笔记——DMA+ADC(单通道+多通道)

单通道&#xff1a; 开启循环模式&#xff0c;两个参数设为word u32 adc_tick0; u32 r37_value0; u32 r38_value0; float r37_volt0; float r38_volt0;//DMAADCvoid DMA_ADC() {if(uwTick-adc_tick<100) return;adc_tick uwTick;HAL_ADC_Start_DMA(&hadc2, &r37_v…

C语言——数据在内存中的存储

引言 数据是程序运行的核心。当我们用C语言编写程序时&#xff0c;我们实际上是在操纵内存中的数据。这些数据在内存中是如何储存的&#xff0c;今天我们就来学习这些内容。 基本数据类型 1.整型 int: 基本整型&#xff0c;通常占用4个字节 short: 短整型&#xff0c;通常占用…

dPET论文笔记

PBPK论文笔记 题目&#xff1a;Self-supervised Learning for Physiologically-Based Pharmacokinetic Modeling in Dynamic PET 摘要 动态正电子发射断层扫描成像 &#xff08;dPET&#xff09; 提供示踪剂的时间分辨图像。从 dPET 中提取的时间活动曲线 &#xff08;TAC&a…

tomcat中间件漏洞

目录 什么是Tmocat Tomcat弱口令 Tomcat 文件上传 (CVE-2017-12615) 什么是Tmocat Tomcat是常见的免费的web服务器. Tomcat 这个名字的来历&#xff0c;Tomcat是一种野外的猫科动物&#xff0c;不依赖人类&#xff0c;独立生活。 Tomcat的作者&#xff0c;取这个名字的初衷…

ubuntu 更改 ssh 默认端口 22 以加固安全

出于加固安全考虑&#xff0c;一般公司会禁用 ssh 的 22 端口号&#xff0c;因此我们需要改为其他端口。 1、ssh 命令行登录 进入台式机&#xff0c;修改 /etc/ssh/sshd_config 文件中的 Port 配置行&#xff0c;将 22 改为 8022&#xff0c;保存修改后&#xff0c;重启 ssh 服…

SHAP安装问题

一、安装 pip install shap -i https://pypi.tuna.tsinghua.edu.cn/simple 二、遇到问题 1、提示报错如下&#xff1a; ModuleNotFoundError: No module named numba.core 安装numba&#xff1a; pip install numba -i https://pypi.tuna.tsinghua.edu.cn/simple 提示已经…

STC89C52学习笔记(十二)

STC89C52学习笔记&#xff08;十二&#xff09; 一、AD/DA 1.定义 AD能够将模拟信号转化为数字信号&#xff0c;DA能够将数字信号转化为模拟信号。 2.两种类型的DA转换器 &#xff08;1&#xff09;PWM型DA滤波器 由于PWM是通过脉冲调制的方法来调整的&#xff0c;低通滤…

Python学习从0到1 day25 第二阶段 SQL ② Python操作数据库

少年有梦&#xff0c;不应至于心动&#xff0c;更要付诸行动 —— 24.4.12 pymysql 除了使用图形化工具以外&#xff0c;我们也可以使用编程语言来执行SQL从而操作数据库 在Python中&#xff0c;使用第三方库&#xff1a;pymysql来完成对MySQl数据库的操作 安装 pip install py…

赋能Web3用户:增强在线隐私

随着数字化时代的发展&#xff0c;人们越来越依赖互联网来进行各种活动&#xff0c;从社交互动到金融交易&#xff0c;几乎所有的日常生活都离不开网络。然而&#xff0c;随之而来的是个人隐私安全面临的挑战。在传统的互联网架构下&#xff0c;用户的个人数据往往被中心化的平…

OpenCV4.10使用形态运算提取水平线和垂直线

目标 在本教程中&#xff0c;您将学习如何&#xff1a; 应用两个非常常见的形态运算符&#xff08;即膨胀和侵蚀&#xff09;&#xff0c;并创建自定义内核&#xff0c;以便在水平轴和垂直轴上提取直线。为此&#xff0c;您将使用以下 OpenCV 函数&#xff1a; erode()dilate…