Git Message 编写指南

我们在日常使用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
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值