美文网首页
如何填写Git的commit?

如何填写Git的commit?

作者: 精益的Tang | 来源:发表于2018-06-19 21:16 被阅读0次

commit信息包括2-3部分:

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

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

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

示例如下:

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

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

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

参考:优达学城

相关文章

  • 如何填写Git的commit?

    commit信息包括2-3部分: 主题,必填项。应简要说明更改的内容,不建议使用“修复”或“执行了某些操作”等字眼...

  • 修改还未push的commit信息

    如果commit后发现message信息填写错误,可通过git commit --ament命令来撤销

  • 【转载】替换gerrit原始的commit-msg hook

    原文地址: 原标题: 升级Gerrit的commit-msg,检查git commit时必须填写开发任务编号Tas...

  • vim命令

    git commit之后进入vim(vi)界面,如何退出 git commit --amend进入vim 编辑器。...

  • 【git】注意事项

    如何写一个Git Commit Message https://cbea.ms/git-commit/[https...

  • git commitizen

    AngularJS团队提交规范 全局安装完成后在使用git commit代码时使用git cz 代替 后按提示填写即可

  • GIT commit 回退

    git add .git commit -m "xxx" git log // 查看commit记录commit ...

  • git commit合并

    如何修改commit common git commit --amend之后使用vim命令正常修改 如何将当前提交...

  • git篇

    1.如何删除github上的文件 git rm --cached filename git commit -m "...

  • git 自己使用心得(3)mac

    如何取消add git reset HEAD 上一次add里面取消 如何取消commit git reset --...

网友评论

      本文标题:如何填写Git的commit?

      本文链接:https://www.haomeiwen.com/subject/rxuzeftx.html