当前位置:   article > 正文

Git Commit Message规范_在 git commit message 中,关于 footer 的描述正确的是?

在 git commit message 中,关于 footer 的描述正确的是?

Commit Message 格式

Commit Message 主要包含三个部分:Header,Body 和 Footer,其中,Header 和Body是必需的,Footer 可以省略。

  • Header【必填】, 描述主要修改类型和内容
  • Body【必填】描述为什么修改, 做了什么样的修改, 以及开发的思路,遗留问题等等

(optional scope):
<空一行>
[body]

Message Header

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

Type

Type 主要用来说明本次提交修改的类别,可以选择如下几种:

  • feat:新功能(feature)
  • fix:修补 bug
  • docs:文档(README、Change Log 等)
  • style: 格式,仅代码格式,不是 CSS 样式
  • refactor:重构(即不是新增功能,也不是修改 Bug 的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动,例如构建脚本、Dockerfile、package.json 的改动

Scope

Scope 用于说明 Commit 影响的范围,可以为空。根据项目情况而定。通常是 设计的项目 module名称。 如果有多个 module“,”分割,如(web,server)

Subject

Subject 是本次 Commit 目的简短描述,不超过 50 个字符。重点是做了什么,而不是描述如何做。

Message Body

Body 主要用于对 Commit 详细的描述以及对 Subject 的补充,可以分成多行。
如果您不知道如何填写 Body,可以从下面三个角度考虑:

  • 为什么这个变更是必须的? 它可能是用来修复一个 Bug,增加一个 Feature,提升性能、可靠性、稳定性等
  • 如何解决这个问题? 具体描述解决问题的步骤
  • 本次提交存在哪些副作用或风险?

示例

feat(web) XM2102301-30 用户目标地图

背景:
http://jira.xxx.com/browse/XM2102301-30

修改:
1. 使用idea自带http工具来替换postman 使postman工具的也可以沉淀下来
2. 新增查询我的目标接口

影响:
影响PC端个人目标地图显示
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/IT小白/article/detail/636735
推荐阅读
相关标签
  

闽ICP备14008679号