Git 初学者指南 — 如何撰写良好的提交信息

你是一名开发者，最近开始使用 Git 了？如果你想知道如何为你的项目创建好的提交信息，那么这篇文章就是为你量身定制的。

经过几周没有写新文章之后，今天我回来写我在 Google 上搜索次数最多的帖子之一的下一部分。

一年前，当我开始写作时，我写了一篇关于如何使用 Git 启动和创建第一个存储库的文章。

这篇文章深受社区赞赏，每周帮助了很多人。因此，本系列的下一篇将探讨如何撰写优秀的提交信息。

什么是好的提交信息？

简单提醒一下，提交信息是你在 Git 上保存工作时留下的简短文本。这条信息的特定目的是识别你的工作。

只要阅读它，任何人都可以清楚地了解您在这部分工作中做了什么。

下面是 GitHub 上 Angular.js 项目（谷歌开发的著名框架）最新提交的示例。可以看到，提交信息非常清晰，我们可以更好地了解各个部分的具体工作。

例如，2019年7月24日，“gkalpak”升级了“SauceConnect”，并切换到最新版本的Safari（网络浏览器）。

GitHub 上Angular.js 项目的 Git 提交历史记录

不幸的是，提交并没有统一的书写方式。每个项目和每个公司都会根据自己的需求定义特定的规则。

别担心；您经常会发现类似的编写消息的方式。

尽管如此，我还是强烈建议您在进入公司或从事开源项目之前阅读规则。

我将在本文后面向您提供有关这些指南的更多详细信息。

我列出了使用良好提交消息的优点的简短清单。

更好的协作：如果您在公司从事开源项目，遵守规则对于更好地合作至关重要。如果您编写的内容易于理解，并遵循项目规则，其他开发人员将能够更高效地工作，他们也无需询问您的工作内容。

注意：如果您正在开发个人项目，我强烈建议您遵循特定的规则。这将提高您的工作效率，并且如果您向其他开发人员寻求帮助，他们也能更轻松地开始处理您的项目。

更好地理解：您需要创建清晰易懂的消息；这将帮助您和合作伙伴更好地开展项目。下面是一个 Git 提交历史记录的示例，其中只有一些不清晰的消息。正如您所见，很难理解其中的内容。

Jason McCreary的糟糕 git 提交示例

注意：如果您想了解更多不良提交的示例并同时获得乐趣，名为“gitlost”的 Twitter 帐户每天都会发布有趣且未经过滤的提交推文。

福利 - 生成变更日志：我告诉你一个小秘密，如果你的提交信息写得好，就能直接从提交信息中生成变更日志。我分享了一些工具来实现这一点：Github 变更日志生成器、Git Chglog、自动变更日志和常规变更日志。本系列的下一篇可能会讲这个，如果你想了解最新动态，可以关注我的 Twitter。我会在那里发布所有更新。

自动生成的 Git 变更日志示例

如果你想写出好的提交信息，你需要遵循一些规则。我在下面列出了一个清单。每次你想要提交代码时，请花点时间参考一下这个清单。

务必检查语法。读到一篇满是错误的文章总是令人不快。为此，我建议你使用语法工具。如果你用英语写作，可以使用Grammarly、Reverso或GrammarCheck。这些工具并非完美无缺，但它们可以纠正大部分错误。
一次提交，一次修改。尽量经常提交。理想情况下，每次修改都提交到不同的提交中。这样更容易回溯到之前的工作。
清晰明了。提交提交时，尽量保持透明。我建议使用简单的英语，直奔主题。
详细说明你做了什么。花点时间重读你的代码，写下你做了什么。如果你需要详细说明，我建议你使用提交的描述部分。

补充信息：我想与大家分享更多关于“git commit”命令的细节。如果您没有使用 git 软件，您应该知道可以通过输入以下命令来创建详细的提交：

$ git commit -m "Title" -m "Description"

它和之前一样，但多了第二部分用于描述。“-m 'title'”用于输入提交的简称，“-m 'description'”用于输入描述（如果需要提供更多详细信息）。

使用 Git 指南。如果你想拥有清晰的 Git 提交历史记录，我建议你遵循指南。它是关于如何提交的指南。就我而言，我选择了Udacity 上的这个简单的指南。还有很多其他的指南；其中一些是常规提交指南和Angular 指南。提交指南可以帮助你为提交添加架构。例如，添加一个标签来阐明你做了什么：“git commit -m fix：当触发“删除帐户”按钮时，正确删除所有用户信息”。

希望你喜欢这篇关于如何提交 Git 的指南！如有任何疑问或反馈，请随时提出。

如果您对如何做出正确的承诺还有其他建议，请告诉我。

如果您想要更多类似的内容，您可以在 Twitter 上关注我，我会在那里发布有关 Web 开发、自我提升以及我作为全栈开发人员的历程的推文！