编写符合行业标准的 Git 提交信息的指南

我敢肯定，在阅读本文之前，你已经听说过 Git 了。无论是什么原因让你来到这里，都欢迎你，希望你能找到解决方案。

Git 的简要说明

我们有一些需要大量贡献的大型项目，Git 可以帮助开发者管理不同的贡献，并将它们整合到一个整体中。它还有助于控制项目的版本，也就是版本控制。这只是一个简单的定义，但这是我能想到的解释 Git 的最佳方式。

Git 的标准定义是：它是一种用于管理源代码的 DevOps 工具。它是一个免费开源的版本控制系统，可以高效地处理从小到大的各种项目。

在继续之前，我建议您先了解一些 Git 工作流程。

Git提交

Git 提交是代码库或项目当前阶段/状态的快照。它允许系统存储已暂存的更改。
提交记录可用作项目贡献和变更的时间线，也有助于定义项目里程碑。提交记录还可以用于跟踪团队的生产力和关键绩效指标 (KPI)。

行业标准 Git 提交

我选择将其描述为技术生态系统中普遍适用的 Git 提交信息。它不应该包含过于复杂的术语，而应该易于阅读和理解，即使是那些不参与代码库贡献的人也能理解。

行业标准的必要性

这样做的目的是为了让你的提交信息与你提交的代码紧密相关。即使你回过头来看代码，也应该能够通过提交信息理解你所做的更改。这也有助于新贡献者理解提交和更改的内容。你可以知道某人为什么提交了某个代码，以及如果你修改了那一行代码会产生什么影响。

您的提交信息应为：

• 可以理解
• 足够的
• 明确的

在撰写提交信息之前，您应该考虑以下几点：

• 我为什么要添加这个提交？
• 这次提交做了哪些更改？
• 这些改变是必要的吗？
• 这些更改是否解决了任何问题，或者是否引用了任何外部链接或代码片段。

我们将要考察的行业标准提交消息方法是：

<type>[optional scope]: <description>

[optional body]

[optional footer]

我们可以了解一下不同的标准提交类型：

修复：这是为了提交代码库中已解决的错误。

功能：这是将新功能提交到代码库的操作。

杂务：此提交的更改与功能或错误无关，它涉及修改或更新依赖项。

重构 - 此提交会提交涉及重构代码的更改，包括重构代码或更改。

文档 - 此提交会将对文档、readme.md 或 markdown 文件所做的更改提交到其他位置。

样式 - 这涉及代码库中的样式更改。

测试 - 此操作会提交测试文件中所做的更改，包括所做的更正。

perf - 此操作旨在提升应用程序的性能。

ci - 此提交会对 CI 集成进行更改，例如文件和脚本。

构建 - 这些文件涉及构建文件和 Blue 依赖项。

回滚 - 此提交表示回滚到之前的提交。

例如：

新增功能：在首页添加提现按钮

您还可以添加带有表情符号的标准提交，不同的提交类型使用不同的表情符号，例如
：修复：已修复联系表单。点击此处
了解更多信息。

结论：

通过写作学习到的技能将提升你的能力，并使你的代码库更加井然有序。记录你的流程并跟踪变更至关重要。

当你的代码变成遗留代码，需要新的开发人员接手时，你的提交信息使得接手的开发人员即使在你不在的情况下也能更轻松地在你的代码库中工作。

如果您对如何改进提交有任何建议，请在下方提出。

我真心希望我们都能从这篇关于改进 Git 提交信息的文章中学到一些东西。