首页 > 其他分享 >Git Commit 规范

Git Commit 规范

时间:2024-03-27 09:24:02浏览次数:35  
标签:Git 规范 git change 提交 commit Commit 模板 subject

背景

git规定提交时必须要写提交信息,作为改动说明保存在 commit 历史中,方便回溯。规范的 log 不仅有助于他人 review,还可以有效的输出 change_log甚至对于项目的研发质量都有很大的提升。参考目前比较流行的Angular团队的commit规范

「Angular commit规范格式」

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

分别对应 Commit message 的三个部分:Header,Body 和 Footer

Header

Header 部分只有一行

包括三个字段:type(必需)、scope(可选)和subject(必需)

  • type::用于说明 commit 的类型,一般有以下几种

    • feat: 新增feature
    • fix: 修复bug
    • docs: 仅仅修改了文档,如readme.md
    • style: 仅仅是对格式进行修改,如逗号、缩进、空格等。不改变代码逻辑
    • refactor: 代码重构,没有新增功能或修复bug
    • perf: 优化相关,如提升性能、用户体验等。
    • test: 测试用例,包括单元测试、集成测试。
    • chore: 改变构建流程、或者增加依赖库、工具等。
    • revert: 版本回滚
  • scope:用于说明 commit 影响的范围

    比如:视图层、控制层、数据层、docs、config、plugin、util、test

  • subject:commit 目的的简短描述

    一般不超过50个字

Body

补充 subject 添加详细说明,可以分成多行

适当增加原因、目的等相关因素,也可不写

参考

 #  body: 72-character wrapped. This should answer:
 # * Why was this change necessary?
 # * How does it address the problem?
 # * Are there any side effects?
 # initial commit

「Footer」

当有当前代码与上一个版本不兼容(Breaking Change)时必须在这里描述清楚

修复的 bug(关闭issue)或是链接到相关文档,如 Closes #1, Closes #2, #3

使用

  1. 设置git 提交信息模板

新建 .gitmessage.txt(模板文件) ,参考内容如下

# headr: <type>(<scope>): <subject>
# - type: feat, fix, docs, style, refactor, test, chore
# - scope: can be empty
# - subject: start with verb (such as 'change'), 50-character line
#
# body: 72-character wrapped. This should answer:
# * Why was this change necessary?
# * How does it address the problem?
# * Are there any side effects?
#
# footer:
# - Include a link to the issue.
# - BREAKING CHANGE
#
  1. 配置提交信息模板
//这个命令只能设置当前分支的提交模板
git config commit.template   [模板文件名]
//这个命令能设置全局的提交模板,注意global前面是两杠
git config  --global commit.template   [模板文件名]

Idea 插件

  1. 安装插件
Untitled
  1. 使用
Untitled
Untitled
Untitled
Untitled

本文使用 markdown.com.cn 排版

标签:Git,规范,git,change,提交,commit,Commit,模板,subject
From: https://www.cnblogs.com/lvlaotou/p/18098164

相关文章

  • GitHub WebHook 使用教程
    本文收录于Github.com/niumoo/JavaNotes,Java系列文档,数据结构与算法!本文收录于网站:https://www.wdbyte.com/,我的公众号:程序猿阿朗什么是WebHookWebHook直译是网络钩子,可以把WebHook看做一种通知方式,只要发生关注的事件,就会发送通知到我们指定的Web服务。使用WebHoo......
  • Git 常用命令速查
    Git是一个分布式版本控制系统,用于管理代码和其他文件。它允许您跟踪代码的更改,并在必要时回滚到以前的版本。本文将介绍一些Git常用命令,帮助您快速上手Git。初始化Git仓库gitinit添加文件到暂存区gitadd<file_name>提交更改gitcommit-m"提交信息"查看......
  • 规范 - 接口文档
    作者:Zonezzc最后更新时间:2024-03-2619:13:06​​原则接口的命名最终一定是便于理解的中文。接口的说明中一定包含接口原名如getSellerStandardsProfile,若存在第三方在线接口文档,该原名设置为引向原文的超链接。所有的参数都要有中文注释。命名规范对接口理解不透彻......
  • 规范 - 接口文档
    规范-接口文档作者:Zonezzc最后更新时间:2024-03-2619:13:06​​原则接口的命名最终一定是便于理解的中文。接口的说明中一定包含接口原名如getSellerStandardsProfile,若存在第三方在线接口文档,该原名设置为引向原文的超链接。所有的参数都要有中文注释。命名规范......
  • Git使用分支最常遇到的问题
    目录Git使用分支最常遇到的问题无法进入分支一、忽略.idea文件二、删除.idea文件三、进入分支四、正常的提交程序分支不能拉取2024/3/26Git使用分支最常遇到的问题无法进入分支前言:原项目克隆下来后,无法进入分支;原因是:检测到未追踪的文件(.idea文件),idea为了运行程序自动生成......
  • 中国黄金集团携手e签宝,推动招投标电子化、规范化
    中国黄金集团有限公司组建于2003年初,其前身是成立于1979年的中国黄金总公司。是国内黄金行业唯一一家中央企业,集团主要从事金、银、铜、钼等有色金属的勘察设计、资源开发、产品生产和销售以及工程总承包等业务,是集地质勘探、矿山开采、选矿冶炼、产品精炼、加工销售、科研开发......
  • 【通过python获取git的分支名】
    前言在git开发时,编译/编译后的文件是依赖于当前的git分支名的,读取其名字,可便于后续的操作。前言导入库声明git指令和路径解析git分支名调用subprocess总结导入库importsubprocess声明git指令和路径cmd_command="gitbranch--show-current"GitBash_path......
  • Git 如何重命名一个 Git Tag 标签
    Git如何重命名一个Gittag标签?方法一:使用Git命令行工具首先,使用gittag命令查看现有的标签列表。例如:$gittagV2.0.0v2.0.1v2.1.2v2.0.3v2.0.4v2.0.5使用gittag<new-name><old-name>命令来重命名标签。例如,要将标签v1.0重命名为v2.0,可以运行以下命......
  • 海量数据处理项目-账号微服务和流量包数据库表+索引规范(下)
    海量数据处理项目-账号微服务和流量包数据库表+索引规范(下)第2集账号微服务和流量包数据库表+索引规范讲解《下》简介:账号微服务和流量包数据库表+索引规范讲解账号和流量包的关系:一对多traffic流量包表思考点海量数据下每天免费次数怎么更新?海量数据付费流量套餐包每天......
  • 使用Github托管Unity项目
    ​准备工作在本机生成ssh密钥ssh-keygen-trsa-C"你的邮箱地址"点击回车后会出现生成的密钥路径,我们直接打开密钥复制下来。github官网添加我们的本机密钥进入Github官网,点击设置,选择SSHandGPGkeys点击newSSHkey,将我们刚才在本机生成的ssh密钥放入key中,并起......