Git Message 编写指南

最新推荐文章于 2024-04-12 05:47:06 发布
最新推荐文章于 2024-04-12 05:47:06 发布
阅读量1.2k 收藏
点赞数
分类专栏： java 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jmysql/article/details/124457213
版权
本文介绍了Angular规范下的Git Commit Message的编写方法，包括Header、Body和Footer三部分，阐述了规范化的Commit Message的好处，如提供历史信息、快速查找和生成Change log。并提供了IDEA中使用Git Commit Template插件的指导，以及各部分的填写说明和实例。
摘要由CSDN通过智能技术生成

我们在日常使用Git提交代码时经常会写 commint message，否则就不允许提交。

一般来说，commit message 应该清晰明了，说明本次提交的目的。

目前，社区有多种 Commit message 的写法规范。本文介绍Angular规范，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。

格式化的Commit message 有什么好处？

  • 提供更多的历史信息，方便快速浏览。

  • 可以过滤某些commit（比如文档改动），便于快速查找信息。

  • 可以直接从commit生成Change log。

Commit message 规范说明

如果使用 IDEA 开发，我们可以先装个插件： Git Commit Template

装完之后重启IDEA，如果我们提交代码会发现多了一个按钮：

image.png

点击之后就会出现一个 Commit Template，主要分为下面三个部分： Header， Body，Footer。

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

image.png

Header

Header的部分只有一行,包括三个字段: type(必需), scope(可选), subject(必需)

对应到idea插件上图的配置分别为 Header部分

最低0.47元/天 解锁文章
jmysql
关注
专栏目录
【Git系列】Git message提交模板格式
CSDN明星博主，认证博客专家，视频、Matlab领域优质创作者。
08-12 841
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的Patch功能和msg模板设置、git服务器搭建、KVM virsh常用命令
LETFLY'S LAB
10-18 460
本文整理编辑自： Git的Patch功能 - 老z的博客 - 博客园 http://yuxu9710108.blog.163.com/blog/static/2375153420101114488765/ 一、前言 UNIX世界的软件开发大多都是协作式的，因此，Patch（补丁）是一个相当重要的东西，因为几乎所有的大型UNIX项目的普通贡献者，都是通过Patch来提交代码的。作为最重要的开源项目之一，Linux，也是这样的。普通开发者从软件仓库clone下代码，然后写入代码，做一个Patc...
Git message提交模板
Guoye的专栏
04-15 5953
不谈使用git message模板的原因或者历史，网上有一堆。相信针对看到这文章的人都知道，目前自己的版本管理中，追溯提交日志时觉得信息凌乱甚至不堪入目。因此才有此想法：统一提交模板 1. 模板格式 规范使用较多的是 Angular 团队的规范，格式如下： <type>(<scop...
git message
Enjolras_fuu的博客
07-09 275
使用原因 git message 应该成为回溯问题的一个迅速定位问题的关键。如果我们不写提交信息，或者在提交信息中写 bug fix 等等， 在回溯问题的时候往往是一头雾水。 团队实践准则 提交代码有原则（粒度） 项目代码稳定之后，每次提交都要考虑提交的粒度问题，尽量做到 baby step 没有关联的代码不能一次 commit 提交 关联代码一次提交；若内容很多，可内部分层，依次提交。 可以根...
【知识整理】Git Commit Message 规范_java git message 提交规范
2401_84181403的博客
04-08 1276
伙伴深入学习提升的进阶课程，基本涵盖了95%以上大数据开发知识点，真正体系化！**
【知识整理】Git Commit Message 规范_git commit msg 规则
最新发布
2401_84183492的博客
04-12 1912
外链图片转存中…(img-VKZ2Dmto-1712871950994)]
git commit message编写指南
jeezx
12-21 2281
0. Commit message编写指南 【声明】参考angular代码规范及部分博客整理，仅学习记录，非商用。 1. 概述 日常开发中使用 git 提交代码要求一定要写 git commit message，否则就无提交代码。 commit message作为改动说明，保存在 commit 历史中，方便回溯。 规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升。 规范git commit到底有哪些好处呢？ 便于程序员对提交历史进
Git 提交的正确姿势：Commit message 编写指南
一年又一年。的专栏
03-27 1769
Git 提交的正确姿势：Commit message 编写指南 文章目录 一、Commit message 的作用 二、Commit message 的格式 2.1 Header 2.2 Body 2.3 Footer 2.4 Revert 三、Commitizen 四、validate-commit-msg 五、生成 Change log http://www.ruany......
Git Commit Message 规范
Dablelv 的博客专栏。
05-11 1477
大咖好呀，我是恋喵大鲤鱼。Git 是一个免费开源的分布式版本控制系统，由 Linux 之父 Linus Torvalds 于 2005 年开发，最初的目的用于管理 Linux 内核的开发。因其高效的性能、便捷的分支管理、免费开源等优秀特性，一经推出，很快在全球范围内得到广泛使用，成为最流行的版本控制系统，没有之一。当我们使用 Git 对代码进行版本管理时，经常需要将变更推送至远端。每次提交变更时，我们需要书写 Commit Message 描述此次变更的内容。
Git Commit Message规范
qq_25775675的博客
10-13 2186
Git commit message规范是一种良好的实践，可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。
Git —— Commit Message 规范介绍
Ccccxc的博客
12-26 2800
日常开发中，我们经常会使用到 Git 进行代码管理，而 Git 中最常用的命令就是git commit，我们通过 commit 命令将修改后的代码提交到本地仓库，然后再通过git push命令将本地仓库的代码推送到远程仓库。git 规定提交时必须要写提交信息，作为改动说明，保存在 commit 历史中，方便回溯。规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升，尤其是一些长期持续迭代维护，且多版本长期并存的项目。
让你的git message更加规范
w候人兮猗
05-21 468
前言 规范比业务开发搬砖更为重要，没有一个好的编码规范，维护老的代码或者是编写新的代码都非常痛苦 Eslint与prettier 大大小小也做过了好几个项目，每个项目都要做eslint校验,所以我封装了一个npm包以后直接安装引入即可 yarn add osdoc-lint -D yarn add prettier 新建.eslintrc.js module.exports = { extends: [require.resolve('osdoc-lint/dist/eslint')], ru
优雅的提交你的 Git Commit Message
琦彦
09-25 494
commit message 是开发的日常操作, 写好 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG, 对项目的管理实际至关重要, 但是实际工作中却常常被大家忽略. 希望通过本文, 能够帮助大家重视和规范 commit message 的书写. 起因 知乎上有个问题: 如何写好 Git commit log? 很有意思, 能看到各种提交风格: 有用 emoji 的, 有用唐诗的, 有用随机生成的. 风格没有对错, 只要能够体现出 commit 所做的修改即可. 但是.
git commit message 规范
哦豁灬
03-30 931
当前版本与之前版本不兼容，如迭代升级对之前版本不能做到兼容，就需要在Breaking Changes后面描述变动理由和迁移方法之类，此属性不常用。body说明提交详细描述：对于功能详细的描述，解释为什么加入这段代码，为什么调整优化等，如因分布式锁问题，导致死锁问题，优化调整xxxx。subject 说明提交简短描述：一般是5-10个字简单描述做的任务，如【xx模块加入消息队列】scope说明提交影响范围：一般是修改的什么模块或者是什么功能，如【xx模块】/【xx功能】在有新的 commit 的时候，在。
Git Message能引起极度舒适？
weixin_33831673的博客
12-06 218
总有理由 本人半强迫症患者一枚，看到各种提交fix bug xxx,甚至连xxx都没有，在回溯问题的时候一头雾水，只能逐个文件找问题。难。。。 所以个人认为Git Message成为回溯问题的一个迅速确定问题的关键。 那什么样的Message是优秀的呢？ 原则又是什么呢？就拿我们一直团队实践的准则来说一说。 提交代码有原则(粒度) 项目代码稳定之后，每次提交都要考虑提交的粒度问题，尽...
格式化你的git message
weixin_30755709的博客
09-18 146
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提交代码使用统一的模板
螃蟹变异了的专栏
10-26 2401
git配置commit通用模板 1.创建模板文件存放在计算机任何位置都可以，比如我存放在/home/crab/.gitmsg_template 2.在文件.gitmsg_template中配置的message信息，比如: [user]crab [mail]xxxxxxxxx [msg ] this is your commit msg. [tel ]123456789 3.配置当前用户.gitco...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值