首页 > 其他分享 >git 提交备注规范

git 提交备注规范

时间:2024-06-22 12:42:28浏览次数:20  
标签:例如 git 代码 修改 用于 提交 feat 备注

git 提交规范
commit message = subject + :+ 空格 + message 主体

例如:feat::增加用户注册功能

常见的 subject 种类以及含义如下:

feat: 新功能(feature)

用于提交新功能。
例如:feat: 增加用户注册功能
fix: 修复 bug

用于提交 bug 修复。
例如:fix: 修复登录页面崩溃的问题
docs: 文档变更

用于提交仅文档相关的修改。
例如:docs: 更新README文件
style: 代码风格变动(不影响代码逻辑)

用于提交仅格式化、标点符号、空白等不影响代码运行的变更。
例如:style: 删除多余的空行
refactor: 代码重构(既不是新增功能也不是修复bug的代码更改)

用于提交代码重构。
例如:refactor: 重构用户验证逻辑
perf: 性能优化

用于提交提升性能的代码修改。
例如:perf: 优化图片加载速度
test: 添加或修改测试

用于提交测试相关的内容。
例如:test: 增加用户模块的单元测试
chore: 杂项(构建过程或辅助工具的变动)

用于提交构建过程、辅助工具等相关的内容修改。
例如:chore: 更新依赖库
build: 构建系统或外部依赖项的变更

用于提交影响构建系统的更改。
例如:build: 升级webpack到版本5
ci: 持续集成配置的变更

用于提交CI配置文件和脚本的修改。
例如:ci: 修改GitHub Actions配置文件
revert: 回滚

用于提交回滚之前的提交。
例如:revert: 回滚feat: 增加用户注册功能
总结
使用规范的提交消息可以让项目更加模块化、易于维护和理解,同时也便于自动化工具(如发布工具或 Changelog 生成器)解析和处理提交记录。

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

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。

原文链接:https://blog.csdn.net/chenyajundd/article/details/139322838

标签:例如,git,代码,修改,用于,提交,feat,备注
From: https://www.cnblogs.com/hlgg/p/18262161

相关文章

  • Hexo 博客搭建并部署到 GitHub Pages(2024最新详细版)
    效果演示我的博客,欢迎添加友链。前置条件本机已安装好Git和Node.js,Node版本一定不要最新的22版本(会出现各种奇怪的问题),建议16和18稳定版本。Git安装Node.js安装1.安装Hexonpminstallhexo-cli-g终端执行hexo-version出现Hexo版本号,说明安装成功2.......
  • vscode中使用gitee
    1.下载安装githttps://www.cnblogs.com/htj10/p/12436737.html2.生成ssh密钥和公钥运行git-bash.exe,或 右键打开GitBashHere检查我们的目录下是否已经有公钥和私钥(如下是有的)#进入用户的目录john是自己的用户名$cd/c/users/john#查看是否有公钥John@DESKTOP-I......
  • git-清空历史提交记录(保留原仓库)
    0.备份进行操作之前,一定一定要先备份,你直接copy项目文件夹也行。1.创建一个新的孤立分支首先,创建一个新的孤立分支(没有历史记录)gitcheckout--orphannew-branch--orphan参数:孤立分支:使用--orphan创建的分支没有任何父提交记录,因此没有任何历史记录。这使得它看起......
  • Git的安装及使用
     官网:GitforWindows   点击下载安装。 右击鼠标会出现GUI和Bash  选择gitbashhere 配置全局用户名和邮箱(gitee)gitconfig--globaluser.name"你的名字"gitconfig--globaluser.email你的邮箱 查看配置gitconfiguser.namegitconfig–list......
  • GitCode Copilot强大的代码助手
    GithubCopilot是由GitHub和OpenAI联合开发的一款人工智能(AI)驱动的代码助手。它基于大量的开源代码和编程语言知识进行训练,可以帮助开发人员快速生成高质量的代码片段。本文将介绍如何使用GithubCopilot以及它的常用快捷键。安装和设置:首先,确保你的开发环境中已经安装了GitH......
  • AWX+gitlab
    目录AWX+gitlab1.Awx配置1.1添加机构1.2添加团队1.3添加主机1.4测试主机连通性2.对接gitlab2.1添加凭证2.2添加项目2.3上传playbook2.3.1克隆仓库2.3.2创建分支2.3.3编写playbook并上传2.3.4上传ansible.cfg(可选)2.3.5创建作业模板2.4测试AWX+gitlab我们可以将pl......
  • Git常用命令
    一、git的作用:-代码回溯:Git在管理文件过程中会记录日志,方便回退到历史版本-版本切换:Git存在分支的概念,一个项目可以有多个分支(版本),可以任意切换-多人协作:Git支持多人协作,即一个团队共同开发一个项目,每个团队成员负责一部分代码,通过Git就可以管理和协调-......
  • SpringBoot+AOP+Redis自定义注解实现防重复提交
    1.哪些因素会引起重复提交?开发项目过程中可能会出现下面这些情况:前端下单按钮重复点击导致订单创建多次网速等原因造成页面卡顿,用户重复刷新提交请求黑客或恶意用户使用Postman等http工具重复恶意提交表单2.重复提交会带来哪些问题?重复提交带来的问题:会导致数据......
  • github怎么设置本地push代码
    从github拉取公开代码使用gitpull即可但是如果想要push则会报错clone代码本次使用个人测试的公开代码因为是公开代码无需验证即可clone#gitclonehttps://github.com/liuyueming/salt.git修改代码提交即使输入的用户名和密码正确也会报错#gitaddtest[root@docke......
  • Git版本回退更新(强制回退、记录回退)
    一.reset的使用方法(会覆盖,不太建议)1.gitlog查看要回退的版本号(也可以代码仓库直接查看版本号)2.使用gitreset--hard(目标版本号)命令将版本回退gitreset--harddaf5cfec176f7b4ab0f11912e84555ec01297e4e3.再强制push到远程,让远程仓库和当前分支保持一致(假定当前......