Git Message能引起极度舒适？

最新推荐文章于 2024-04-08 11:48:51 发布
最新推荐文章于 2024-04-08 11:48:51 发布
阅读量202 收藏 1
点赞数
文章标签： git javascript ViewUI
原文链接：https://juejin.im/post/5c08c24a6fb9a04a0b21f754
版权

总有理由

本人半强迫症患者一枚，看到各种提交fix bug xxx,甚至连xxx都没有，在回溯问题的时候一头雾水，只能逐个文件找问题。难。。。

所以个人认为Git Message成为回溯问题的一个迅速确定问题的关键。

那什么样的Message是优秀的呢？ 原则又是什么呢？就拿我们一直团队实践的准则来说一说。

提交代码有原则(粒度)

项目代码稳定之后，每次提交都要考虑提交的粒度问题，尽量做到 baby step

  • 没有关联的代码不能一次commit提交
  • 关联代码一次提交；若内容很多，可内部分层，依次提交

可以根据当前代码模块情况处理。

必须提交Commit Message

  • 没有Commit Message 当然不能提交
  • 不在 git commit 上增加 -m <msg> 或 --message=<msg> 参数，而单独写提交信息

不推荐

git commit -m "Fix login bug"
复制代码

推荐

angular的GitHub的Commit


Fix(filterFilter): fix filtering using an object expression when the …
…filter value is undefined

Fixes #10419
Closes #10424
复制代码

Commit Message分段写

Commit Message 分三个部分， header, body, footer. 其中，header 是必需的，body 和 footer 可以省略。 不管是哪一个部分，任何一行都不得超过100个字符，以免影响阅读性。

[<team>]<type>(<scope>): <subject>

<body>

<footer>&emsp;
复制代码
[FE]Fix(card): fix card edit, support to unuse item

在card修改里面，添加配置item未使用功能
复制代码

header

Header部分只有一行，包括四个字段：type（必需）、scope（可选）、team（可选）和subject（必需）。

type

用于说明 commit 的类别，只允许使用下面7个标识。

Add：新加功能

Fix：修补bug

Modify：移除无用代码

Remove：移除第三方模块或者移除文件

Update：更新第三方模块

Style： 格式（不影响代码运行的变动）

Chore：构建过程或辅助工具的变动
复制代码
scope

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

例如在shrezone，可以是file, card, image, short_video等。

如果你的修改影响了不止一个scope，你可以使用*代替。

team

当不同的team一起编写代码的时候，带team以区分工作区域

subject

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

其他注意事项：

以动词开头，使用第一人称现在时，比如change，而不是changed或changes

第一个字母小写

结尾不加句号（.）
复制代码

Body

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

比如react的提交

Sync out another jsx transform test.

We added this test internally and it never got added here. We haven't broken it
with any transforms *yet* but it's still good to actually run all of our tests
here too.
复制代码

注意点:

使用第一人称现在时，比如使用change而不是changed或changes。

要和header之间有一个空行

应该说明代码变动的动机，以及与以前行为的对比。
复制代码

Footer

Footer 部分只用于以下两种情况：

不兼容变动

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

关闭 Issue

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

Revert

一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。

revert: feat(pencil): add ‘graphiteWidth‘ option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02
复制代码

最后

当然在很多时候，也不能每次都按照规范来写Commit Message，但是最起码每次重要的提交都能写，关键时候有用。

当然有人会用打tag的方式来表明重要节点，但是毕竟物尽其用，个有所长。

如果爱好使用工具的朋友也可以自行研究：

weixin_33831673
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Git Message 编写指南
jmysql的博客
04-27 1201
我们在日常使用Git提交代码时经常会写 commint message，否则就不允许提交。 一般来说，commit message 应该清晰明了，说明本次提交的目的。 目前，社区有多种 Commit message 的写法规范。本文介绍Angular规范，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。 格式化的Commit message 有什么好处？ 提供更多的历史信息，方便快速浏览。 可以过滤某些commit（比如文档改动），便于快速查找信息。 可以直接从c
git message
Enjolras_fuu的博客
07-09 255
使用原因 git message 应该成为回溯问题的一个迅速定位问题的关键。如果我们不写提交信息，或者在提交信息中写 bug fix 等等， 在回溯问题的时候往往是一头雾水。 团队实践准则 提交代码有原则（粒度） 项目代码稳定之后，每次提交都要考虑提交的粒度问题，尽量做到 baby step 没有关联的代码不能一次 commit 提交 关联代码一次提交；若内容很多，可内部分层，依次提交。 可以根...
Git message提交模板
Guoye的专栏
04-15 5819
不谈使用git message模板的原因或者历史，网上有一堆。相信针对看到这文章的人都知道，目前自己的版本管理中，追溯提交日志时觉得信息凌乱甚至不堪入目。因此才有此想法：统一提交模板 1. 模板格式 规范使用较多的是 Angular 团队的规范，格式如下： <type>(<scop...
Git Commit Message 最佳实践
Dablelv 的博客专栏。
05-11 1286
大咖好呀，我是恋喵大鲤鱼。Git 是一个免费开源的分布式版本控制系统，由 Linux 之父 Linus Torvalds 于 2005 年开发，最初的目的用于管理 Linux 内核的开发。因其高效的性能、便捷的分支管理、免费开源等优秀特性，一经推出，很快在全球范围内得到广泛使用，成为最流行的版本控制系统，没有之一。当我们使用 Git 对代码进行版本管理时，经常需要将变更推送至远端。每次提交变更时，我们需要书写 Commit Message 描述此次变更的内容。
Git Commit Message规范
qq_25775675的博客
10-13 2092
Git commit message规范是一种良好的实践，可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。
Git学完后能干什么？
03-06
Git学完后能干什么？
如何使用Git提高研发团队工作效率？
02-24
本文来自segmentfault，文章介绍了Git的特点、Git提供的三种工作流程以及Git分支的管理等相关内容。随着互联网时代的来临与发展，尤其分布式开发的大力引入，对于开发工程师来说，代码管理变成了头等难题。10多个人...
git fork同步是什么意思？
01-20
概要： 克隆别人的代码库到自己的项目中，可以作为子模块的形式使用，或二次开发 操作流程： 在开源项目中点击fork按钮，稍等一会儿，该项目便会拷贝一份到你的respositories中，克隆一份代码到本地：git clone ...git
Git天天用但是Git原理你了解吗？
01-27
做技术一定要知其然知其所以然，意思就是：知道它是这样的，更知道它为什么是这样的。我主要通过4块内容来简单介绍 Git原理是什么样的。这4块内容如下： Git存储目录结构介绍 ...Git引用当然Git原理不
【知识整理】Git Commit Message 规范_java git message 提交规范
最新发布
2401_84181403的博客
04-08 1187
伙伴深入学习提升的进阶课程，基本涵盖了95%以上大数据开发知识点，真正体系化！**
Git —— Commit Message 规范介绍
Ccccxc的博客
12-26 2241
日常开发中，我们经常会使用到 Git 进行代码管理，而 Git 中最常用的命令就是git commit，我们通过 commit 命令将修改后的代码提交到本地仓库，然后再通过git push命令将本地仓库的代码推送到远程仓库。git 规定提交时必须要写提交信息，作为改动说明，保存在 commit 历史中，方便回溯。规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升，尤其是一些长期持续迭代维护，且多版本长期并存的项目。
格式化你的git message
weixin_30755709的博客
09-18 129
https://github.com/angular/angular.js/blob/f3377da6a748007c11fde090890ee58fae4cefa5/CONTRIBUTING.md#commit Git Commit Guidelines We have very precise rules over how our git commit message...
如何规范 Git Message
weixin_33717117的博客
06-16 243
为什么要关注提交信息 加快 Reviewing Code 的过程 帮助我们写好 release note 5年后帮你快速想起来某个分支，tag 或者 commit 增加了什么功能，改变了哪些代码 让其他的开发者在运行 git blame 的时候想跪谢 总之一个好的提交信息，会帮助你提高项目的整体质量 更专业化管理好你的项目，提高项目完整性 Angular 规范的 Commit message ...
Git 提交规范
本末实验室
03-21 2745
在正式参与项目开发之前，了解并且坚持使用一些规范更方便我们与同事之间的合作。这些通常是约定俗成的。 git提交准则 git源码中的Documentation/SubmittingPatches列举了git提交规范相关的说明文档。 提交之前的注意事项 1、检查空白错误 git diff --check #确认将提交的内容中有无空白信息 2、尝试让每一个提交成为一个逻辑上的独立变更集 尽量使每一...
【知识整理】Git Commit Message 规范_java git message 提交规范(1)
2401_84181383的博客
04-08 765
伙伴深入学习提升的进阶课程，基本涵盖了95%以上大数据开发知识点，真正体系化！**
【git】使用模板编辑commit message
Shi_zhaopeng的博客
04-12 1023
1.创建名为commit.template模板文件2.设置模板路径3.设置编辑器配置当前配置全局4.将修改纳入管理输入git commit后会自动跳转到编辑模板的页面，只需在模板中填写即可推送到远端仓库，如果只是在本地管理代码，不需要执行此命令。
git commit message编写指南
jeezx
12-21 2232
0. Commit message编写指南 【声明】参考angular代码规范及部分博客整理，仅学习记录，非商用。 1. 概述 日常开发中使用 git 提交代码要求一定要写 git commit message，否则就无提交代码。 commit message作为改动说明，保存在 commit 历史中，方便回溯。 规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升。 规范git commit到底有哪些好处呢？ 便于程序员对提交历史进
【Git系列】Git message提交模板格式
CSDN明星博主，认证博客专家，视频、Matlab领域优质创作者。
08-12 807
DATE: 2020.8.13 文章目录1、参考2、Gitmessage格式和模板2.1 Gitmessage格式2.2 Gitmessage模板3、模板设置相关命令4、git-commit编辑器nano改vim 1、参考 Git message提交模板 Git 提交的正确姿势：Commit message 编写指南 2、Gitmessage格式和模板 2.1 Gitmessage格式 每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。 <type&g
Git学习笔记（五）——修改commit message
DivingKitten Coding驿站
05-23 4111
在使用git过程中，经常会需要修改提交message的情况，下面是借助rebase对本地提交message修改的示例。 一、修改最近一次的提交的message git commit -amend 修改完成后:wq保存退出即可。 二、修改历史提交的message 通过rebase方式修改历史commit message，指令格式如下： git rebase -i HASH 指定需要修改commit的前一次commit id，将需要修改message的commit修改Commands为reword，无需修改
git是什么？怎么学习？
05-03
Git是一个版本控制系统，它可以帮助开发者跟踪代码的变化、协作开发和管理代码库。学习Git非常重要，因为它是现代软件开发的基础之一。 学习Git的步骤如下： 1. 安装Git：在电脑上安装Git，可以到Git官网下载...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值