我是怎么写 Git Commit message 的？

最新推荐文章于 2023-11-12 22:32:20 发布
最新推荐文章于 2023-11-12 22:32:20 发布
阅读量387 收藏
点赞数
文章标签： html js css web 数据可视化
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/XinLiangTalk/article/details/118282830
版权

文章目录：

  • 作用

  • 用的什么规范？

    • type

    • scope

    • subject

    • body

    • footer

    • 参考文章

  • 用的什么辅助工具？

  • 推荐阅读

作用

编写格式化的 commit message 能够大大提高代码的维护效率。

比如：

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

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

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

用的什么规范？

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

其中，Header 是必需的，Body 和 Footer 可以省略。

type

type 用于说明 commit 的类别。

  • feature A new feature

  • fix A bug fix

  • docs Documentation only changes

  • style Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

  • refactor A code change that neither fixes a bug nor adds a feature

  • perf A code change that improves performance

  • test Adding missing tests or correcting existing tests

  • build Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)

  • ci Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)

  • chore Other changes that don't modify src or test files

  • revert Reverts a previous commit

scope

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

subject

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

body

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

footer

BREAKING CHANGE，用来描述当前 commit 与上一个版本不兼容的地方。

Issue，用来描述当前 commit 针对的某个issue。

参考文章

Commit message 和 Change log 编写指南[1]

用的什么辅助工具？

太教条了，太累... 给大家分享一个我使用的工具。

JetBrains IDE 插件，在 GoLand、PhpStorm 中 都可以在插件市场搜索 Git Commit Message Helper。

插件地址：Git Commit Message Helper[2]

安装后效果，在 git commit 时：

咱们看一下效果：

这时，点击 Commit 或 Commit and Push... 即可。

赶快去体验吧。

推荐阅读

参考资料

[1]

Commit message 和 Change log 编写指南: http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

[2]

Git Commit Message Helper: https://plugins.jetbrains.com/plugin/13477-git-commit-message-helper

程序员新亮
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Git Commit Message 应该怎么写？
OUDUIDUI的博客
05-10 534
因为入职至今，公司也没有太规定一个代码提交规范，所以一直以来，我代码提交的commit message都是简单的一句话说明了本次代码改动内容，有时候会更加精简。 但时间长了之后，当我需要回头找一下某次提交记录的时候，就会发现不太好找，首先没有一个具体的分类，比如是添加功能、还是修复bug、还是更新文档等等；其次就是有一些message写得不是很清晰，不太能一眼明了那次改动是什么内容。 后来决定，需要重新学一学关于commit message的写法规范。 Commit Message的好处 每一条提交记录的
Commit message 和 Change log 编写指南
流水不腐小夏
01-06 1800
转载http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。 $ git commit -m "hello world" 上面代码的-m参数，就是用来指定 commit mesage 的。 如果
写出好的 commit message
AlienTech for better life!~
12-26 1862
为什幺要关注提交信息 加快 Reviewing Code 的过程帮助我们写好 release note5年后帮你快速想起来某个分支，tag 或者 commit 增加了什么功能，改变了哪些代码让其他的开发者在运行 git blame 的时候想跪谢总之一个好的提交信息，会帮助你提高项目的整体质量 基本要求 第一行应该少于50个字。 随后是一个空行 第一行题目也可以写成：Fix i
Git commit message规范及编写方法
haorenSW7的博客
01-14 721
说明：整理描述一下自己目前对 Angular规范 的理解，主要用于指导自己平时工作中commit message的编写，仅供参考。
Git Commit message 编写规范
yanglingchao的博客
04-21 1003
在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。上面代码的-m参数，就是用来指定 commit mesage 的。如果一行不够，可以只执行git commit，就会跳出文本编译器，让你写多行。git commit在我们开发中，直接在idea中装插件使用，其中必填为type和short description；
idea git commit插件
03-24
idea commit 模板插件
leetcode2-git-commit-message-helper:一个帮助git代码提交规范的JetBrains系列插件，支持IDEA、
06-29
git-commit-message-helper 本插件是源idea插件的升级版，增加了一系列个性化配置。 安装 直接从 IDE 插件管理器安装（文件 > 设置 > 插件 > 浏览器存储库 > Git Commit Message Helper） 用法 如果要更改提交类型，...
How to Write a Git Commit Message
04-25
- 利用诸如`git commit --amend`或提交钩子等工具帮助优化提交过程。 通过遵循上述规则和技巧，你可以显著提高自己的提交消息质量，从而更好地与团队成员沟通并维护项目的历史记录。优秀的提交消息不仅能够提升...
git修改已commit的注释信息实现
10-15
在Git版本控制系统中，提交注释（commit message）是记录代码变更的重要部分，它有助于团队成员理解每次提交的目的和变化内容。有时，在提交后我们可能会发现注释信息不够准确或全面，这时就需要修改已提交的commit...
GitEmoji- emoji for git commit message-crx插件
04-02
语言:English (United States) 表情符号的git commit消息 提交消息的表情符号指南。 它只是https://gitmoji.carloscuesta.me/的Chrome扩展版本
Git代码提交软件
10-31
一个优秀的团队合作离不开git，一个优秀的程序员也离不开git。gitkraken是我在进行软工实践这门课接触到的git的UI界面的工具
如何填写“提交消息(Commit messae)”
可信计算的博客
03-27 267
总结大约 50 个字符或更少的变化。请解释此次提交正在解决的问题。 专注于你为什么进行此次变更而不是你如何变更了（代码对此进行了解释）。 这次改变是否有副作用或其他不直观的后果？ 这是解释它们的地方。 更多的段落在空行之后。 - 也可以提出要点 - 通常在项目符号之前使用连字符或星号加上一个空格，中间有空行，除非另有约定。 如果您使用议题跟踪器，请将对它们的引用放在底部，
Git Commit message编写指南
编程浅谈
02-17 385
一、Commit message 的作用 格式化的Commit message，有几个好处。 1.提供更多的历史信息，方便快速浏览 比如，下面的命令显示上次发布后的变动，每个commit占据一行。你只看行首，就知道某次 commit 的目的 git log <last tag> HEAD --pretty=format:%s 2.可以过滤某些commit（比如文档改动），便于快速查...
git commit message编写指南
jeezx
12-21 2219
0. Commit message编写指南 【声明】参考angular代码规范及部分博客整理，仅学习记录，非商用。 1. 概述 日常开发中使用 git 提交代码要求一定要写 git commit message，否则就无提交代码。 commit message作为改动说明，保存在 commit 历史中，方便回溯。 规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升。 规范git commit到底有哪些好处呢？ 便于程序员对提交历史进
Git Commit 应该怎么写？
weixin_33948416的博客
07-11 342
2019独角兽企业重金招聘Python工程师标准>>> ...
Commit Message 的编写
for the dream
07-11 638
Commit Message 作用 每次 git commit 时，都需要编写相应的说明，否则是不允许提交的。 commit message 应该清晰明了的说明本次提交的目的。 规范的 commit message 有利于： 对 git log 进行分析和查找 也有利用使用工具进行格式化的文档生成 Angular 规范写法 每次提交，Commit message 都应当包括三个部分...
Git Commit 之道：规范化 Commit Message 写作指南
最新发布
pursuit的博客
11-12 8531
在软件开发的征程中，清晰明了的 Git Commit Messages 是项目成功的关键。本指南将教你如何通过规范化 Git 提交信息，提高代码可读性，以及如何巧妙撰写自动生成的 Change Logs，精准记录项目的演变。让你的团队与你共同领略 Git Commit 的精髓，推动项目可维护性的巅峰。
Commit message 写法规范
cab5的博客
11-18 812
一、概述 对于日志的提交一直都没有形成一个很好的规范（每次提交都比较随意：<），最近看到一篇文章，里边有一章节介绍了一种写法规范（感觉还不错:>），从该文得知当前业界比较广泛应用的是 Angular Git Commit Guidelines https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines 二、具体格式 <type>: <subject> &l
git commit正确写法
Shaun's blog
04-21 1247
哈哈哈
git commit message helper
09-01
git commit message helper是一个辅助工具，用于帮助我们编写更好的git提交信息。 在进行版本控制时，我们通常会使用git进行代码管理，并且会通过提交(commit)来记录每次的修改。一个好的提交信息可以让其他人更...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值