关于Commit message代码提交

最新推荐文章于 2024-02-23 19:03:00 发布
最新推荐文章于 2024-02-23 19:03:00 发布
阅读量1.6k 收藏 3
点赞数 1
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40618816/article/details/113263043
版权

Commit message代码提交规范

目录

一、简述

commit message 提交说明：应清晰明了，说明本次提交目的
社区有多种 Commit message 的写法规范。
Angular 规范（如图）是目前使用最广的写法，比较合理和系统化，并且有配套的工具。
在这里插入图片描述

Commit message 的作用：

1、提供更多的历史信息，方便快速浏览
比如，下面的命令显示上次发布后的变动，每个commit占据一行。只看行首可知某次commit目的（图见下）

$ git log <last tag> HEAD --pretty=format:%s

在这里插入图片描述
2、过滤某些commit（比如文档改动），便于快速查找信息
比如，下面的命令仅仅显示本次发布新增加的功能

$ git log <last release> HEAD --grep feature

3、直接从commit生成Change log
Change Log 是发布新版本时，用来说明与上一个版本差异的文档
在这里插入图片描述
4、可读性好，清晰，快速了解当前commit的作用
5、为 Code Reviewing（代码审查）做准备
6、方便跟踪工程历史
7、提高项目的整体质量，提高个人工程素质

二、Commit message格式–命令行方式

Commit message 包括三个部分：Header，Body 和 Footer

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

1、Header

只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）

（1）type：说明 commit 的类别，只允许使用下面的标识

- feat：新增功能（feature）

- fix/to：修补bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。
  fix：产生diff并自动修复此问题。适合于一次提交直接修复问题
  to：只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix

- docs：文档（documentation），仅仅修改了文档，比如 README, CHANGELOG, CONTRIBUTE等等

- style： 格式（不影响代码运行的变动），仅仅修改了空格、格式缩进、逗号等等，不改变代码逻辑

- refactor：重构（即不是新增功能，也不是修改bug的代码变动）

- test：增加测试，包括单元测试、集成测试等

- chore：构建过程或辅助工具的变动

- type：代表某次提交的类型，比如是修复一个bug还是增加一个新的feature

- perf: 优化相关，比如提升性能、体验

- revert: 回滚到上一个版本

- ci：自动化流程配置修改

- merge：代码合并

- sync：同步主线或分支的Bug

注：
若type为feat和fix，则该 commit 将肯定出现在 Change log 之中；
其他情况（docs、chore、style、refactor、test）由自己决定是否放入 Change log，建议不要。

（2）scope：说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

（3）subject：

subject是 commit 目的的简短描述，不超过50个字符。

a.建议使用中文（感觉中国人用中文描述问题能更清楚一些）。
b.以动词开头，使用第一人称现在时，比如change，而不是changed或changes
c.第一个字母小写
d.结尾不加句号（.）或其他标点符号

根据以上规范git commit message将是如下的格式

fix(DAO):用户查询缺少username属性 

feat(Controller):用户查询接口开发

2、Body

对本次 commit 的详细描述，可以分成多行

More detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

注：
a.使用第一人称现在时，比如使用change而不是changed或changes。
b.应该说明代码变动的动机，以及与以前行为的对比。

3、Footer

只用于两种情况：不兼容变动、关闭 Issue

（1）不兼容变动
如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法

BREAKING CHANGE: isolate scope bindings definition has changed.

To migrate the code follow the example below:

Before:

scope: {
  myAttr: 'attribute',
}

After:

scope: {
  myAttr: '@',
}

 The removed `inject` wasn't generaly useful for directives so there should be no code using it.

（2）关闭Issue
如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue

Closes #234

也可以一次关闭多个 issue

Closes #123, #245, #992

4、Revert

如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header

revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

① Body部分的格式是固定的，必须写成This reverts commit ，其中的hash是被撤销 commit 的 SHA 标识符。
② 如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change log 的Reverts小标题下面。

三、工具

1、Commitizen

Commitizen是一个格式化commit message的工具。

安装命令：

$ npm install -g commitizen

Then，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。

$ commitizen init cz-conventional-changelog --save --save-exact

After，凡是用到git commit命令，一律改为使用git cz。这时，就会出现选项，用来生成符合格式的 Commit message。
在这里插入图片描述

2、validate-commit-msg

validate-commit-msg 用于检查 Node 项目的 Commit message 是否符合格式。

手动安装
First，拷贝下面这个JS文件，放入代码库。文件名可以取为validate-commit-msg.js。
Then，把这个脚本加入 Git 的 hook。下面是在package.json里面使用 ghooks，把这个脚本加为commit-msg时运行。

  "config": {
    "ghooks": {
      "commit-msg": "./validate-commit-msg.js"
    }
  }

Finally，每次git commit的时候，这个脚本就会自动检查 Commit message 是否合格。如果不合格，就会报错。

$ git add -A 
$ git commit -m "edit markdown" 
INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" ! was: edit markdown

四、TortoiseSVN提交日志规范

日志提交简单规则：

message提交：版本号 type类别 提交信息描述

  1. 完成某个任务，尽可能提交该任务，原则是一个任务一次提交。
  2. 提交格式：[任务号 任务标题]
    在这里插入图片描述
  3. 当几个任务一起完成提交时，可以把几个相同类似的任务分批提交：
    格式：[功能名称：任务1 编码 任务2 编码 任务3 编码 …… 任务n 编码]
    注：不提倡
    在这里插入图片描述
  4. 某些原因没有提交正确格式时，需要进行更正：
    右键 → Edit log message 更正提交的日志信息
    修改保存后，本机这边改变了，其他机器上即便更新代码，并没有改变，因为TortiseSVN会缓存。
    需要设置Settings → Saved Data中，将Log messages xxx都 clear 即可
    在这里插入图片描述
    在这里插入图片描述
  5. 提交日志时，以下几项严禁和反对：
    1）完全与项目无关的
    2）与项目有关但语义不清

相关参考链接

Commit message 代码提交规范
commit message和 Change log 编写指南
Git 提交的正确姿势：Commit message 编写指南
【Git学了就忘-实操（二）】修改已提交commit的message
TortoiseSVN提交日志规范
SVN与TortoiseSVN修改日志和强制写日志实现详解
SVN实现详解与TortoiseSVN修改日志和强制写日志
SVN常见的错误及处理方法
[Subversion] 修改旧版次的讯息与作者名称
[转][SVN] Hook scripts的使用方法
[Subversion] 修改舊版次的訊息與作者名稱


当你为错过太阳而哭泣的时候，你也要再错过群星了。 ——泰戈尔

Little-BingoQ
关注
  • 1
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
validate-commit-message:GIT COMMIT-MSG挂钩，用于验证提交消息
05-04
验证提交消息 GIT COMMIT-MSG挂钩，用于验证提交消息。 $ validate-commit-msg创建到./lib/validate-commit-msg.js的符号链接.git/hooks/commit-msg ，该链接在每次提交时执行。 钩子脚本根据在每次提交时验证提交消息。 安装 $ npm install validate-commit-message 用法 您可以从项目的命令行激活挂钩。 $ node ./node_modules/.bin/validate-commit-msg 一种更一致的方法是在package.json添加一个脚本。 "scripts": { "init": "validate-commit-msg" } 然后执行$ npm run init 。
commit-msg文件的意义
qq_37796239的博客
03-04 465
commit-msg` 钩子在提交消息被提交之前触发，允许你检查和修改提交消息。要使用`commit-msg`钩子，你需要在Git仓库的`.git/hooks`目录下创建一个名为`commit-msg`的脚本文件，并确保它是可执行的。默认情况下，`.git/hooks`目录中的钩子示例都是禁用的（文件扩展名为`.sample`）。这个脚本使用`grep`来检查提交消息是否以`feat:`、`fix:`等允许的前缀之一开始。除了校验，`commit-msg` 钩子也可以用来自动向提交消息添加信息。
【知识整理】Git Commit Message 规范
李木
02-23 2167
前面咱们整理过Code Review 一文，提到了 Review 的重要性，已经同过gitlab进行CodeReview 的方式，那么本文详细说明一下对CodeReivew非常重要的Git Commit Message 规范。我们在每次提交代码时，都需要编写 Commit Message，否则是不允许提交的。书写好的 Commit Message 能大大提高代码维护的效率。避免开发人员在项目中群魔乱舞，搞得代码一团糟，搞的项目就被糟践了。且开发日后的维护，都将是灾难。
Git 最佳实践：commit msg
<sdffdsfsdfdfs>sfsfsfsdfsdffds</sdfsDS>Fsd
02-05 727
点击上方“程序员大咖”，选择“置顶公众号”关键时刻，第一时间送达！1.引言git commit 是很小的一件事情，但是往往小的事情往往引不起大家的关注，不妨打开公司的 gitlab 上的任一个 repo，查看 commit log，满篇的 update 和 fix，完全不知道这些 commit 是要做啥。下面就说一些最近的看到和自己尝试的一些还不错的实践。2. Tips1. one thing o
gitHooks: commit-msg
snowball的博客
12-10 3921
gitHooks: commit-msg
开发过程中，记得规范你的 commit msg
厦门在乎科技
11-08 685
规范 commit msg 的意义 规范化、格式化的 commit message 可以让我们更好的追踪需求的演进、回滚时能够快速的找到提交、最次也能让我们的仓库显的更专业。 团队如何规范 commit msg呢，靠宣讲、靠文档？当然得靠工具生成和约束。前端圈轮子那么多，这种工具不在话下。 commitizen 问答式生成 commit msg格式化 commitlint 校验卡控 commit msg规范化 commitizen commitizen: simple commit conve..
Git commit message规范
lingyang999的博客
08-16 6118
参考文档：https://mp.weixin.qq.com/s/mAUqTPCqcYjoNDqAxktyfA 使用工具简介：commitizen、cz-conventional-changelog、commitlint、husky commitizen：Commitizen是一款提升GIT提交过程效率的小工具。它会提示你提供任何必要字段，还会恰当地格式化提交信息。Commitizen内置了对多种提交规范的支持，同时还允许你定制自己的提交规则。这个简单的工具能够节约时间，而不必等待提交钩子运行检查再驳回提
Shell脚本案例：Git规范commit-msg
csfchh的博客
08-09 947
git本身自带hooks入口，支持用户通过脚本的方式在git命令执行前后进行一些检查工作，使用的脚本语言为Shell。相关hook脚本需放在本地.git/hooks目录下，打开该目录可以看到很多示例脚本，我们要用到的正是commit-msg这个。 只需要将对应脚本的后缀.sample去掉即可启动该脚本，然后我们将脚本内容修改为自己的脚本逻辑即可： #!/bin/sh COMMIT_MSG=`cat $1 | egrep "^(feat|fix|docs|chore)\(\w+\)?:\s(\S|\w)+
Git Commit 之道：规范化 Commit Message 写作指南
pursuit的博客
11-12 3161
在软件开发的征程中，清晰明了的 Git Commit Messages 是项目成功的关键。本指南将教你如何通过规范化 Git 提交信息，提高代码可读性，以及如何巧妙撰写自动生成的 Change Logs，精准记录项目的演变。让你的团队与你共同领略 Git Commit 的精髓，推动项目可维护性的巅峰。
vscode-commit-message-editor:以方便的方式编辑提交消息
03-09
commit-message-editor.confirmAmend ：在修改提交消息之前显示确认对话框 commit-message-editor.staticTemplate ：文本视图的模板 commit-message-editor.dynamicTemplate ：表单视图的模板 commit-message-...
leetcode2-git-commit-message-helper:一个帮助git代码提交规范的JetBrains系列插件，支持IDEA、
06-29
git-commit-message-helper 本插件是源idea插件的升级版，增加了一系列个性化配置。 安装 直接从 IDE 插件管理器安装（文件 > 设置 > 插件 > 浏览器存储库 > Git Commit Message Helper） 用法 如果要更改提交类型，...
Commit-Message-Plugin:提交信息模板规范化插件
05-19
Commit-Message-Plugin提交信息模板规范化插件一、代码提交规范化的目的为了部门提交代码信息格式规范化为了更好的追溯代码、筛选为了更加快速的定位提交代码所涉及的范围和实现功能为了后续代码的Review、自动生成...
commit-message-lint:Github应用程序可验证请求请求中的提交消息
03-15
提交消息棉绒 Github应用程序可验证提交消息并在拉取请求上拉取请求标题 描述 此应用程序对提交消息运行格式检查，并在创建请求请求时运行请求请求标题。 ...COMMIT_MESSAGE_REGEX: <Commit> OUTPU
commit-msg
12-18
拷贝commit-msg到每个需要使用gerrit提交代码的项目中 将commit-msg文件拷贝到 -> 项目文件夹\.git\hooks（文件夹不存在则新建）， 这时将上次commit的代码reset后再次commit and push -> push to Gerrit即可。 详情...
python学习导航.txt
05-06
python
node-v8.3.0-linux-s390x.tar.xz
05-06
Node.js，简称Node，是一个开源且跨平台的JavaScript运行时环境，它允许在浏览器外运行JavaScript代码。Node.js于2009年由Ryan Dahl创立，旨在创建高性能的Web服务器和网络应用程序。它基于Google Chrome的V8 JavaScript引擎，可以在Windows、Linux、Unix、Mac OS X等操作系统上运行。 Node.js的特点之一是事件驱动和非阻塞I/O模型，这使得它非常适合处理大量并发连接，从而在构建实时应用程序如在线游戏、聊天应用以及实时通讯服务时表现卓越。此外，Node.js使用了模块化的架构，通过npm（Node package manager，Node包管理器）,社区成员可以共享和复用代码，极大地促进了Node.js生态系统的发展和扩张。 Node.js不仅用于服务器端开发。随着技术的发展，它也被用于构建工具链、开发桌面应用程序、物联网设备等。Node.js能够处理文件系统、操作数据库、处理网络请求等，因此，开发者可以用JavaScript编写全栈应用程序，这一点大大提高了开发效率和便捷性。 在实践中，许多大型企业和组织已经采用Node.js作为其Web应用程序的开发平台，如Netflix、PayPal和Walmart等。它们利用Node.js提高了应用性能，简化了开发流程，并且能更快地响应市场需求。
嵌入式微处理器设计及应用
05-06
摘要：为满足智能家居座椅的交互式运动控制需求，基于AT89S52设计了嵌入式座椅运动控制系统。使用VB.net设计了游戏手柄按键读取软件，并在此基础上设计了座椅运动控制软件，软件可分别在“手柄模式”和“鼠标模式”下与嵌入式座椅运动控制器通信，进而控制座椅进行加速、减速、正转和反转等运动；构建了控制系统实验装置，实验结果表明，“鼠标模式”下，通过鼠标点击控制软件上功能按钮可实现对座椅的准确运动控制；“手柄模式”下，游戏手柄不仅可控制座椅运动，还可同步控制电脑上运行的游戏或远程遥控车，实现浸入感较强的座椅运动娱乐应用。
2024年中国NFC RFID阅读器行业研究报告.docx
05-06
2024年中国NFC RFID阅读器行业研究报告
node-v9.9.0-linux-ppc64le.tar.xz
最新发布
05-06
Node.js，简称Node，是一个开源且跨平台的JavaScript运行时环境，它允许在浏览器外运行JavaScript代码。Node.js于2009年由Ryan Dahl创立，旨在创建高性能的Web服务器和网络应用程序。它基于Google Chrome的V8 JavaScript引擎，可以在Windows、Linux、Unix、Mac OS X等操作系统上运行。 Node.js的特点之一是事件驱动和非阻塞I/O模型，这使得它非常适合处理大量并发连接，从而在构建实时应用程序如在线游戏、聊天应用以及实时通讯服务时表现卓越。此外，Node.js使用了模块化的架构，通过npm（Node package manager，Node包管理器）,社区成员可以共享和复用代码，极大地促进了Node.js生态系统的发展和扩张。 Node.js不仅用于服务器端开发。随着技术的发展，它也被用于构建工具链、开发桌面应用程序、物联网设备等。Node.js能够处理文件系统、操作数据库、处理网络请求等，因此，开发者可以用JavaScript编写全栈应用程序，这一点大大提高了开发效率和便捷性。 在实践中，许多大型企业和组织已经采用Node.js作为其Web应用程序的开发平台，如Netflix、PayPal和Walmart等。它们利用Node.js提高了应用性能，简化了开发流程，并且能更快地响应市场需求。
git commit 提交代码到分支
06-09
提交代码到分支的步骤如下： 1. 首先，使用命令 `git add` 将你修改过的文件添加到暂存区，例如： ``` git add file1.txt file2.txt ``` 2. 然后，使用命令 `git commit` 将暂存区的修改提交到本地分支，例如： ``` git commit -m "commit message" ``` 其中，`-m` 参数后面的字符串是你的提交信息，用于描述本次提交的内容。 3. 最后，使用命令 `git push` 将本地分支的修改推送到远程分支，例如： ``` git push origin local-branch:remote-branch ``` 其中，`local-branch` 是本地分支的名称，`remote-branch` 是远程分支的名称。如果你的本地分支和远程分支名称相同，可以简写为： ``` git push origin branch-name ``` 这样就完成了将代码提交到分支的过程。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值