当前位置: 首页 > 编程笔记 >

Git 好的提交信息

韩高峯
2023-03-14
本文向大家介绍Git 好的提交信息,包括了Git 好的提交信息的使用技巧和注意事项,需要的朋友参考一下

示例

对于一个遍历的人来说,重要的是git log要容易地理解每个提交的含义是很重要的。良好的提交消息通常包括跟踪器中的许多任务或问题,以及对完成的内容,原因以及有时的完成方式的简要说明。

更好的消息可能看起来像:

TASK-123: Implement login through OAuth
TASK-124: Add auto minification of JS/CSS files
TASK-125: Fix minifier error when name > 200 chars

而以下消息将不太有用:

fix                         // 修复了什么?
just a bit of a change      // 有什么变化?
TASK-371                    // 完全没有描述,读者将需要自己查看跟踪器以获得解释
Implemented IFoo in IBar    // 为什么需要它?

测试提交消息是否以正确的心情进行测试的一种方法是用消息替换空白并查看是否有意义:

如果添加此提交,我将___到我的存储库。

优秀的git commit消息的七个规则

  1. 用空白行将主题行与正文分开

  2. 将主题行限制为50个字符

  3. 大写主题行

  4. 主题行不要以句号结尾

  5. 在主题行中使用命令式语气

  6. 手动将正文的每一行换成72个字符

  7. 用身体来解释什么为什么而不是如何

克里斯·比姆(Chris Beam)博客的7条规则。

 类似资料:
  • git 闪烁消息效果由特殊字符实现,该特殊字符可以在 Vim 等编辑器中输入,但同时需要终端支持。 制作方式 首先,输入 git commit 进入默认编辑器修改 commit 信息,进入 Vim 的插入模式, 输入 Ctrl + v,放手后再按 Esc 键即可得到形如 ^[ 的字符(实际上并不是); 紧接着再输入 [5m,之后再输入 commit 信息(这里假设内容为 COMMIT_MESSAG

  • 本文向大家介绍Git 提交后,包括了Git 提交后的使用技巧和注意事项,需要的朋友参考一下 示例 该挂钩在commit-msg挂钩之后立即被调用。它不能更改git commit操作的结果,因此主要用于通知目的。 该脚本不带任何参数,并且其退出状态不会以任何方式影响提交。

  • 受 Growth 3.0 开发的影响,最近更新文章的频率会有所降低。今天,让我们来谈谈一个好的 Git、SVN 提交信息是怎样规范出来的。 在团队协作中,使用版本管理工具 Git、SVN 几乎都是这个行业的标准。当我们提交代码的时候,需要编写提交信息(commit message)。 而提交信息的主要用途是:告诉这个项目的人,这次代码提交里做了些什么。如,我更新了 React Native Ele

  • 在本文章教程中,我们将演示如何查看 Git 存储库的文件和提交文件记录,并对存储库中的文件作修改和提交。 注意:在开始学习本教程之前,先克隆一个存储库,有关如何克隆存储库,请参考: http://www.yiibai.com/git/git_clone_operation.html 在上一步中,我们已经修改了 main.py 文件中的代码,在代码中定义了两个变量并提交代码,但是要再次添加和修改ma

  • 在 提交失败,错误0个文件提交,3个文件提交失败:无法创建'C:/xampp/htdocs/project/. git/index.lock':文件存在 另一个git进程似乎正在该存储库中运行,例如,由“git提交”打开的编辑器。请确保所有进程都已终止,然后重试。如果仍然失败,那么git进程可能已经在此存储库中崩溃:手动删除该文件以继续。 我关闭了所有开放的终端,反复尝试,但没有成功。 谢谢你的建

  • 当本地文件变更以后,可以通过VCS —> Git —> Commit File 弹出提交变更窗口. 当然,分支合并过后也会弹出提交变更窗口. 配置提交信息 提交变更窗口中你可以选择Change list,也可以选择要提交的变更文件,默认是全选的. 在Author中选择或者输入作者名字.选择Amend commit(修订提交)会在Commit Message中添加上一次的提交信息. 在提交之前,你还