【github 使用相关】提交pr和commit message Conventional Commits 规范 代码提交的描述该写什么?

目录

    • Git 提交信息格式
      • 格式描述
      • Subject(标题)
      • Body(正文)
    • 规范的标签(Tag)
    • 示例
  • CG

Git 提交信息格式

格式描述

  • 一般开源项目代码库根目录都会有一个 CONTRIBUTING.md 或者其他类似名字的文档来介绍如何开始贡献,像https://github.com/imputnet/cobalt/blob/main/CONTRIBUTING.md。贡献代码时需要注意 commit message 的规范,可能每个开源项目的要求不尽相同,但大多遵守以下的conventional commits(中文版)格式:
<type>[optional scope]: <description>[optional body][optional footer(s)]
  • 提交信息通常分为三部分,主要由 subjectbody 组成:

    1. Subject(标题):简短、简洁的一行描述,通常限制在 50 字符以内。
    2. 空行:在 subject 和 body 之间留一个空行,以区分两部分。
    3. Body(正文):提供更详细的描述,包括为什么做这个修改、修改的内容、相关的上下文等。建议每行长度限制为 72 个字符。

Subject(标题)

  • 简短描述:不超过 50 个字符,描述改动的主题。
  • 使用标签:用类型标签开头,描述改动的操作类型。
  • 没有句号:标题行不加句号。

Body(正文)

  • 解释背景和动机:详细描述为什么做这个改动?有无相关的 bug 或任务?
  • 描述具体修改内容:改动了什么,解决了什么问题。
  • 每行限制在 72 个字符以内:使得正文内容更加易于阅读,特别是在终端或者 Git 日志中查看时。

规范的标签(Tag)

在提交 Git commit message 时,使用规范的标签(Tag)有助于清晰地表达提交内容,方便团队协作和版本管理。

  • feat:新增功能(feature)
    示例:feat: 新增用户登录功能

  • fix:修复 Bug
    示例:fix: 修复登录页面崩溃问题

  • docs:仅文档修改(Documentation)
    示例:docs: 更新接口文档

  • style:代码格式调整,不影响功能(不涉及逻辑修改)
    示例:style: 格式化代码,调整缩进

  • refactor:重构代码(不影响功能和修复 Bug)
    示例:refactor: 优化登录逻辑,提升代码可读性

  • chore:其他杂项(构建、依赖管理、脚本任务)
    示例:chore: 更新依赖包版本

  • perf:性能优化(Performance)
    示例:perf: 优化数据加载速度

  • test:新增或修改测试代码
    示例:test: 增加登录接口单元测试

  • ci:CI/CD 配置修改(持续集成相关)
    示例:ci: 修改GitHub Actions配置

  • build:构建相关的修改(如webpack、rollup配置)
    示例:build: 调整打包配置,支持多环境打包

  • revert:回滚之前的提交
    示例:revert: 回滚错误的提交 abc123

  • wip(Work In Progress):进行中的工作,未完成的任务
    示例:wip: 页面样式调整中

  • feat+fix:新增功能并修复相关 Bug
    示例:feat/fix: 增加注册功能并修复输入校验问题

  • chore+docs:更新依赖并调整文档
    示例:chore/docs: 更新依赖并修复API文档错误

示例

feat: Add **** to utilize **** // 添加新性能的commit message
  • 新增了登录功能,并且是为了利用用户身份验证 API
feat: Add login functionality to utilize user authentication API
  • 修改了某个 bug,并且用方法 A 替换了方法 B:
fix: Replace method B with method A to resolve issue with data processing
  • 完整示例:
fix: Replace method A with method B in test to handle IndexedDB async read issue across browsersDue to occasional issues with IndexedDB async reads across different browser versions, method B is used in the test to ensure consistent behavior and data processing.

CG

  • AI Commits|自动生成 commit message 工具

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

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

相关文章

142.WEB渗透测试-信息收集-小程序、app(13)

免责声明&#xff1a;内容仅供学习参考&#xff0c;请合法利用知识&#xff0c;禁止进行违法犯罪活动&#xff01; 内容参考于&#xff1a; 易锦网校会员专享课 上一个内容&#xff1a;141.WEB渗透测试-信息收集-小程序、app&#xff08;12&#xff09; 软件用法&#xff0c…

电路研究9.2——合宙Air780EP使用AT指令

这里正式研究AT指令的学习了&#xff0c;之前只是接触的AT指令&#xff0c;这里则是深入分析AT指令了。 软件的开发方式&#xff1a; AT&#xff1a;MCU 做主控&#xff0c;MCU 发 AT 命令给模组的开发方式&#xff0c;模组仅提供标准的 AT 固件&#xff0c; 所有的业务控制逻辑…

亚博microros小车-原生ubuntu支持系列:1 键盘控制

背景&#xff1a;电脑配置不太行&#xff0c;我在ubuntu再运行vmware&#xff0c;里面运行亚博官方的虚拟机镜像ubuntu&#xff0c;系统很卡。基本上8G内存给打满了。还是想把亚博官方的代码迁移出来&#xff0c;之前售后就说除了官方镜像虚拟机&#xff0c;需要自己摸索迁移。…

Linux中关于glibc包编译升级导致服务器死机或者linux命令无法使用的情况

服务器上编译glibc2.29版本导致命令不能用 Inconsistency detected by ld.so: dl-call-libc-early-init.c: 37: _dl_call_libc_early_init: Assertion sym ! NULL failed!下面是造成不可用的原因 1.编译完gcc 2.29版本后&#xff0c;开始做映射&#xff0c;以达到能使用最新版…

C语言进程与线程编程实战:IPC机制与线程同步详解

系列文章目录 01-C语言从零到精通&#xff1a;常用运算符完全指南&#xff0c;掌握算术、逻辑与关系运算 02-C语言控制结构全解析&#xff1a;轻松掌握条件语句与循环语句 03-C语言函数参数传递深入解析&#xff1a;传值与传地址的区别与应用实例 04-C语言数组与字符串操作全解…

ubuntu k8s 1.31

ubuntu 系统 设置 更新源 apt-get upgradeapt upgradeapt update apt-get update释放root sudo passwd root密码su - 密码设置root可以登录 cd /etc/ssh/sshd_config.d && vi ssh.confPermitRootLogin yes PasswordAuthentication yes:wq 保存退出 systemctl resta…

第4章 神经网络【1】——损失函数

4.1.从数据中学习 实际的神经网络中&#xff0c;参数的数量成千上万&#xff0c;因此&#xff0c;需要由数据自动决定权重参数的值。 4.1.1.数据驱动 数据是机器学习的核心。 我们的目标是要提取出特征量&#xff0c;特征量指的是从输入数据/图像中提取出的本质的数 …

如何获取小程序的code在uniapp开发中

如何获取小程序的code在uniapp开发中&#xff0c;也就是本地环境&#xff0c;微信开发者工具中获取code&#xff0c;这里的操作是页面一进入就获取code登录&#xff0c;没有登录页面的交互&#xff0c;所以写在了APP.vue中&#xff0c;也就是小程序一打开就获取用户的code APP.…

Blazor-选择循环语句

今天我们来说说Blazor选择语句和循环语句。 下面我们以一个简单的例子来讲解相关的语法&#xff0c;我已经创建好了一个Student类&#xff0c;以此类来进行语法的运用 因为我们需要交互性所以我们将类创建在*.client目录下 if 我们做一个学生信息的显示&#xff0c;Gender为…

科家多功能美发梳:科技赋能,重塑秀发新生

在繁忙的都市生活中,头皮健康与秀发养护成为了现代人不可忽视的日常课题。近日,科家电动按摩梳以其卓越的性能和创新设计,赢得了广大消费者的青睐。这款集科技与美学于一身的美发梳,不仅搭载了2亿负离子、6000次/分钟的声波振动等前沿技术,更融入了650nm聚能环红光与415nm强劲蓝…

代码随想录day3

203:移除链表元素&#xff1a;注意虚拟头节点的使用 ListNode* removeElements(ListNode* head, int val) {ListNode* result new ListNode();result->next head;ListNode* current result;while(current ! nullptr && current->next ! nullptr){if(current-…

嵌入式硬件篇---ADC模拟-数字转换

文章目录 前言第一部分&#xff1a;STM32 ADC的主要特点1.分辨率2.多通道3.转换模式4.转换速度5.触发源6.数据对齐7.温度传感器和Vrefint通道 第二部分&#xff1a;STM32 ADC的工作流程&#xff1a;1.配置ADC2.启动ADC转换 第三部分&#xff1a;ADC转化1.抽样2.量化3.编码 第四…

14-6-2C++的list

(一&#xff09;list对象的带参数构造 1.list&#xff08;elem);//构造函数将n个elem拷贝给本身 #include <iostream> #include <list> using namespace std; int main() { list<int> lst(3,7); list<int>::iterator it; for(itlst.begi…

编译安装PaddleClas@openKylin(失败,安装好后报错缺scikit-learn)

编译安装 前置需求&#xff1a; 手工安装swig和faiss-cpu pip install swig pip install faiss-cpu 小技巧&#xff0c;pip编译安装的时候&#xff0c;可以加上--jobs64来多核编译。 注意先升级pip版本&#xff1a;pip install pip -U pip3 install faiss-cpu --config-s…

【GoLang】利用validator包实现服务端参数校验时自定义错误信息

在C/S架构下&#xff0c;服务端在校验请求参数时&#xff0c;若出现参数错误&#xff0c;要响应给客户端一个错误消息&#xff0c;通常我们会统一响应“参数错误”。 但是&#xff0c;如果只是一味的提示参数错误&#xff0c;我并不知道具体是哪个参数错了呀&#xff01;能不能…

Web 代理、爬行器和爬虫

目录 Web 在线网页代理服务器的使用方法Web 在线网页代理服务器使用流程详解注意事项 Web 请求和响应中的代理方式Web 开发中的请求方法借助代理进行文件下载的示例 Web 服务器请求代理方式代理、网关和隧道的概念参考文献说明 爬虫的工作原理及案例网络爬虫概述爬虫工作原理 W…

《智人之上:从石器时代到 AI 时代的信息网络简史》介绍

《智人之上&#xff1a;从石器时代到AI时代的信息网络简史》是尤瓦尔赫拉利于2024年推出的新作&#xff0c;以下是关于这本书的详细介绍&#xff1a; ### 作者简介 尤瓦尔赫拉利&#xff0c;1976年出生于以色列海法&#xff0c;成长于世俗犹太家庭。他3岁自学读书&#xff0c;…

在无法联网的Linux主机或者容器内远程连接主机部署或者容器版的postgresql数据库

最近做的项目遇到一个问题&#xff0c;需要在Linux主机或者容器内&#xff08;内网环境&#xff0c;无法联网下载postgresql资源&#xff09;&#xff0c;访问远程环境上主机或者容器部署的postgresql数据库&#xff0c;进行数据库数据备份和恢复。 我们知道&#xff0c;直接在…

C语言内存管理详解

C语言不像其他高级语言那样提供自动内存管理&#xff0c;它要求程序员手动进行内存的分配和释放。在C语言中&#xff0c;动态内存的管理主要依赖于 malloc、calloc、realloc 和 free 等函数。理解这些函数的用法、内存泄漏的原因及其防止方法&#xff0c;对于编写高效、可靠的C…