如何做出正确的 git commit

在我最近的GitKon 演讲中，我谈到了git commit良好提交的意义。

git commit是一个用于将代码提交到特定位置的命令；例如本地、云端、分支、主目录等。大多数开发人员在想要提交修复、代码块、拼写错误或类似内容时都会使用它。对一个或多个文件进行更改后，一旦您满意，就可以进行提交。这基本上就像将文件保存到项目中一样。只不过，您不是点击“保存”按钮，而是输入git commit。

但有时提交信息会变得杂乱无章。没人知道它们的含义、哪些文件被修改了，或者应该多久提交一次。

我回答了一些关于如何做出良好承诺以及良好承诺如何使您成为一名优秀的团队成员的问题。

为什么它很重要

在我深入探讨使用提交可以做的一些很酷的事情以及您应该做什么之前，让我们先看看为什么它很重要。

编写代码时，许多人都在团队中工作。无论您是为公司编写代码，还是致力于开源项目，您都需要关注您的团队。团队合作的关键在于协作。如果您不知道您的团队在做什么，您就无法成功。

你的提交可以帮助你的团队了解（并提醒你）你正在做什么。你正在编写的代码、正在开发的功能以及修复的错误。

如果你的提交信息杂乱无章，很难知道到底发生了什么。项目启动需要更多时间，而且你的巴士系数又非常高。例如，下面这个就是一团糟：

所有这些都是在同一天提交的，但关于提交内容的信息却很少。

相反，如果您的承诺是好的，那么每个人都会达成共识，产品会更快地发货，您的客户会更满意......您也是如此！

那么什么才是好的承诺呢？

好的提交

在进行提交时，记住几件事很重要。

首先，你需要定期提交代码。提交历史记录允许你回退到项目中某个特定的“保存”点。如果代码中存在严重的 bug 或错误，你可以恢复到“先前已知的稳定版本”。如果你没有定期提交代码，那么你将很难做到这一点。

提交时，务必确保内容具体、易于理解。这就是提交信息的意义所在。提交时，与 Word 文档等简单的“保存”文件不同，您需要在提交中添加信息。这些信息称为提交消息。

编写提交信息

当你在电脑上保存文件时，它只是“保存”而已。你无法在其中添加任何信息。Git 的妙处在于，你可以为“保存”的内容添加注释。每次提交代码时，都应该添加提交消息。

提交消息可以帮助你和你的团队了解代码的用途。为什么此时要“保存”代码？你添加了哪些行？它们的作用是什么？没错，就像上面的例子一样，你可以使用-m多个提交注释来编写提交注释。

撰写良好的提交信息有助于您和您的团队了解保存点。如果您需要恢复到之前的“保存”版本，这将非常有帮助。或者，如果您恰好外出度假，每个人都无需您询问就能知道您提交了什么。

在我的课程中，有人问我一些好的提交示例。你的组织或社区中可能已经有关于提交信息撰写的最佳实践。用一两行文字简短描述你所做的事情会很有帮助。

以下是我的一些提交消息示例：

有很多很棒的例子。例如， Chris Beams写了一篇关于如何撰写提交信息的精彩文章。Beams 建议牢记一些规则，例如区分主题和正文，以及解释提交的内容。阅读全文，了解所有七个技巧！

最重要的是要记住，边发布边学习🚀是可以的。如果你太纠结于提交信息，最终什么都没提交，那也没用。你可以寻求反馈，并查看项目中其他提交信息以获取指导。

TL;DR

如果你没时间读完这些，那么在提交时只需记住三件事。那就是：

• 及时
• 具体的
• 可以理解

接受commit挑战

下次编写提交消息时，请问自己一些问题：

• “我的团队会理解我所做的事情吗？”
• “我会明白我做了什么吗？”
• “我的团队中的每个人，包括非开发人员，都能理解我所做的事情吗？”
• “我是一个好的团队成员吗？”“我沟通能力强吗？”

如果你问这些问题，那么你应该有令人惊叹的提交信息❤️每个人都会因此而喜欢你，并且你的项目会更加整洁和易于理解。

现在，去让世界变得更美好，一次一个承诺。

标题图片由 Arian Darvishi 通过Unsplash提供。