commit信息包括2-3部分:
-
主题,必填项。应简要说明更改的内容,不建议使用“修复”或“执行了某些操作”等字眼,应尽可能清晰、明确,以祈使语气描述提交的任务。可以采取
类型:主题
的模式。类型如:新功能、错误修复、文档更改、格式、代码重构、测试代码、配置等。 -
正文,选填项但实际也是必填。需要详细描述进行更改的原因,但不要超过72个字符。同时主题与正文应有空行,也可以使用短横线作为项目符号。特别简单的,比如更正了一个拼写错误,主题描述就足够清晰的时候,可以不用正文。
-
脚注,通常用于关联其它信息,初学者可不填。
示例如下:
功能:用 50 个或更少字符总结改动
如有必要,提供更详细的阐释文本。将其限制在 72 个字符左右。有些情况下,第一行被视为提交的主题,其余文本被视为正文。将摘要与正文分隔开的空行至关重要(除非你完全省略正文);如果不分隔摘要和正文,“log”、“shortlog”和“rebase”等工具可能不知所措。
解释此次提交要解决的问题。重点是为什么要进行此次改动而不是如何改动(代码会说明这一点)。此次改动是否有任何副作用或其他不太直观的后果?可在此处解释这些方面。
空行后面可以有更多段落。
- 还可以使用项目符号分项列出
- 通常使用连字符或星号作为项目符号,前面有一个空格,中间是一些空行,但惯例不尽相同
如果你使用问题跟踪器,请在底部提供对问题的引用,
例如:
解决:# 123
另请参见:# 456、# 789
参考:优达学城
网友评论