在Git提交摘要中标记?

时间:2017-09-12 13:17:36

标签: git commit-message

人们是否在一行提交摘要中使用提交中的标签?

是否有标准标签或常用标签?

Git支持" tags"但它似乎主要用于标记版本,如" v1.8.5-rc1"。 通过"标记"我并不是说要标记提交或分支,例如" v1.8.5-rc1"例如。

MediaWiki可以将修改标记为minor,表示为 m ,机器人编辑为 b

人们是否在提交消息中添加标签?

示例:

[trivial] Add 'foo()' method to 'Bar' class
[minor] Add 'foo()' method to 'Bar' class
[wip] Add 'foo()' method to 'Bar' class
  • 人们会使用这样的标签吗?
  • 这是常见做法吗?
  • 这些被称为标签,或者这些被称为什么?
  • 有标准标签吗?
  • 是否有常用的标签?
  • 什么标签常用?
  • 语法是什么,是用方括号括起来的一个词吗?

1 个答案:

答案 0 :(得分:0)

Git提交消息约定是多个 一切都取决于你想用它做什么。

我想说这个名称只是“提交消息约定”,或者更确切地说是用于“提交消息标记”的用例。

一个是Angular convention,使用“type”,它是以下之一:

  • feat(功能)
  • 修复(错误修复)
  • docs(文档)
  • 样式(格式化,缺少半冒号,......)
  • 重构
  • 测试(添加缺失的测试时)
  • 家务(维护)

其他一些人使用different/more types,甚至emoji在邮件中添加提交信息。

由您来定义自己的提交消息约定(或使用现有的约定) 如果要从提交消息生成更改日志,则必须明确定义约定,并且格式必须允许自动解析

正如您所发现的,git "tag"概念完全不同,是一种命名特定提交的方法,主要用于发布。

顺便说一句,你的例子中有一些不好的做法: - “WIP”概念应该在分支中 - 提交消息应回答“为什么?”的问题。不是“什么?” (git diff已经提供了此信息。请查看“A Note About Git Commit Messages