📜  如何在 GitHub 中编写好的提交消息?

📅  最后修改于: 2021-10-24 12:57:28             🧑  作者: Mango

版本控制或源代码控制是跟踪您对软件代码所做的更改的做法。版本控制系统是帮助软件团队管理其源代码更改的工具。版本控制软件会跟踪您对特殊类型数据库中的代码所做的每一次修改。版本控制软件是现代软件开发人员实践中最重要的部分。市场上有很多版本控制软件,但最常用的版本控制软件是 Git。

在 Git 中,我们使用 commit 命令在暂存后将更改保存到我们的存储库。换句话说, git commit 创建一个提交,就像在特定时间整个存储库的快照。当您进行提交时,您必须向其添加提交消息,以便它可以帮助您在将来需要时识别特定的提交。

如何使用 Git 编写提交消息?

有两种方法可以编写提交消息:

  • 编辑方法
  • 命令行方法

编辑方法

当您必须添加冗长的描述时使用它,但当我们必须添加简短的提交消息时它不常用。

要使用此方法,请运行不带选项的 git commit 命令,它将打开默认的文本编辑器。在已经打开的编辑器中,第一行是主题,它给出了关于提交的简短描述,然后在它之后留下一个空行,空行之后的所有内容都是扩展描述。您还可以根据自己的选择更改默认编辑器。

编辑器方法的语法如下:

因此,此命令将打开您的默认编辑器,您可以在其中添加有关该提交的主题和简短描述。您可以通过以下方式添加提交的主题和正文:

命令行方法

这是最常用的方法,您可以在其中使用 git commit 命令在一行中添加提交消息。

命令行方法的语法如下:

这里的第一个和第二个 -m 选项分别是主题和描述。

为什么我们要编写好的提交信息?

无论您是在从事个人项目还是团队项目,都必须编写良好的提交消息,因为这是向您的团队成员或为您的项目做出贡献的其他开发人员传达更改上下文的唯一方式。良好的提交信息还可以帮助您轻松理解过去进行某些更改的原因。良好的提交消息可以加深理解,从而提高开发和协作的效率。

如何写出好的提交信息?

不同的开发人员和团队遵循许多约定来编写提交消息,但有许多技巧可以帮助您遵循更好的约定来编写提交消息。

这里有一些技巧可以帮助你写出好的提交信息——

  • 在提交消息的主题中指明提交的类型。您应该根据您所做的更改指定提交类型。例如,如果您对文档进行了更改,则应按以下方式指定您的提交 –

在上面给出的提交消息中,’docs’ 显示了提交的类型或显示文档中进行了更改。同样,您可以使用 ‘fix’ 进行错误修复,使用 ‘style’ 进行与样式相关的更新,并使用 ‘test’ 进行相关测试。

  • 不要使用不必要的标点符号。一些开发人员在提交消息中使用标点符号,这不是一个好习惯,因为有时它可能看起来非常不专业或丑陋。例如,许多开发人员不注意编写正确的提交消息,他们只是添加带有大量标点符号的随机文本。您可以查看下面给出的此类提交消息:

您可以注意到,在上面给出的提交消息中,我们使用了大量标点符号,这使得提交消息更加丑陋和混乱。所以,尽量让你的提交消息标点符号免费。

  • 主题和描述使用大写。没有必要使用大写,但这通常是一种很好的做法。
  • 添加说明以解释您进行了哪些更改以及您为何进行更改
  • 不要假设审阅者会理解原始问题是什么,请确保将其添加到提交消息中
  • 在主题中使用祈使语气
  • 遵循您的团队定义的约定

提交消息最重要的一点是它应该清晰且有意义。编写好的提交消息显示了您作为贡献者的活跃程度。