为什么我应该使用Git提交消息的编辑器?

时间:2010-08-16 21:37:46

标签: git

我感觉几乎每个人都使用编辑器(Vim,Notepad ++等)来获取Git提交消息。为什么呢?

我发现键入-m并且几个引号很简单,并提供了一种简单的方法来重做提交(按向上箭头)。我想在编辑器中做多行提交消息更容易,但我有足够的时间说服其他同事写任何消息!

5 个答案:

答案 0 :(得分:17)

你提到了最重要的事情 - 长度。提交消息本质上总是是多行的。唯一的例外是琐碎的提交(例如“将版本号提升到X.X.X”)或合并没有冲突(尽管如此,附加短信并不是一个坏主意)。就这样的事情而言,平均承诺应该超出主题一两句话;有些甚至可以有段落。看看log of git.git;它几乎可以保证成为提交消息样式和长度的一个很好的例子。

我意识到说服其他人编写好的提交消息可能很难,但这并不意味着你不能 - 而且你可能会发现使用编辑器编写它们会更容易。

(我在我的工作场所拥有完全相同的经验。我的同事首先是工程师,第二是程序员,版本控制用户......第三是慷慨。但你至少可以做你的工作右!)

答案 1 :(得分:8)

正确的git commit消息几乎总是多行的。来自the official git-commit discussion

  

虽然不是必需的,但这是个好主意   用a开始提交消息   单短(少于50个字符)   随后总结了这一变化   通过一个空行然后更多   详尽的描述。转向的工具   提交到电子邮件,例如,使用   主题:第一行   和其余的提交   体。

如果您很难获得任何提交消息,(与您的系统管理员和/或交谈)确保至少有一个GIT_EDITOR环境变量,core.editor配置变量,VISUAL环境变量或EDITOR环境变量设置为有用的东西。

一个选项是创建自己的“编辑器”,提示短(<50个字符)描述,然后是最少数量的字符或句子。这可能不太受欢迎,但这取决于您的职位和工作环境的文化。

答案 2 :(得分:7)

有些人有约定,such as the following

  

简短(50个或更少)的摘要   变化

     

更详细的说明文字,如果   必要。包裹它到约72   人物左右。在某些情况下,   第一行被视为   电子邮件的主题和其余部分   文本作为正文。空白行   将摘要与正文分开   是至关重要的(除非你省略身体   完全);像rebase这样的工具可以搞定   如果你把两者混在一起会很困惑。

     

在提交中写下您的提交消息   现在时:“修复bug”而不是   “修正了错误。”这个惯例匹配   生成的提交消息   像git merge和git这样的命令   还原

     

其他段落后空白   线。

     

- 子弹点也没关系

     

- 通常使用连字符或星号作为子弹,前面加上
  单个空格,中有空行   之间,但惯例各不相同

     

- 使用悬挂式缩进

祝你好运,不使用编辑器。

答案 3 :(得分:2)

在编辑器中,您可以编写更长的消息,进行格式化,例如80列的对齐等等。也许您有一个模板用于复制和粘贴的提交消息。你可以在文本编辑器中做这些事情。

答案 4 :(得分:1)

我首先开始学习vim,将其设置为Mercurial的默认编辑器;如果我想做任何事情,它迫使我至少知道基本命令。现在我一直在使用vim。