如何填写Git的commit?

commit信息包括2-3部分:

  • 主题,必填项。应简要说明更改的内容,不建议使用“修复”或“执行了某些操作”等字眼,应尽可能清晰、明确,以祈使语气描述提交的任务。可以采取类型:主题的模式。类型如:新功能、错误修复、文档更改、格式、代码重构、测试代码、配置等。

  • 正文,选填项但实际也是必填。需要详细描述进行更改的原因,但不要超过72个字符。同时主题与正文应有空行,也可以使用短横线作为项目符号。特别简单的,比如更正了一个拼写错误,主题描述就足够清晰的时候,可以不用正文。

  • 脚注,通常用于关联其它信息,初学者可不填。

示例如下:

功能:用 50 个或更少字符总结改动

如有必要,提供更详细的阐释文本。将其限制在 72 个字符左右。有些情况下,第一行被视为提交的主题,其余文本被视为正文。将摘要与正文分隔开的空行至关重要(除非你完全省略正文);如果不分隔摘要和正文,“log”、“shortlog”和“rebase”等工具可能不知所措。
解释此次提交要解决的问题。重点是为什么要进行此次改动而不是如何改动(代码会说明这一点)。此次改动是否有任何副作用或其他不太直观的后果?可在此处解释这些方面。
空行后面可以有更多段落。
 - 还可以使用项目符号分项列出
 - 通常使用连字符或星号作为项目符号,前面有一个空格,中间是一些空行,但惯例不尽相同
如果你使用问题跟踪器,请在底部提供对问题的引用,
例如:

解决:# 123
另请参见:# 456、# 789

参考:优达学城

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 136,782评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 179,540评论 25 708
  • 用pwntools的DynELF模块来实现 DynELF的基本框架 p = process('./xxx')def...
    zs0zrc阅读 358评论 0 0
  • 背景描述铺货的时候要对照bach那边的库存做校验,不同蜂房要查看的sku列表是相同的,但是每个sku在每个蜂房的库...
    缄默的石头阅读 699评论 0 0
  • 凌家翔是一个大三的学生,由于是个不良少年,高考没考好,上了一个很差的大学。在大学里,他每天都上网、打架、逃课。 ...
    千里一俊阅读 546评论 1 1

友情链接更多精彩内容