你的 Git 提交信息写得正确吗？

说到版本控制，Git 是一个非常有效的工具。然而，就像任何其他工具一样，你必须正确使用它才能发挥其最大效用。你需要考虑很多方面。本文重点介绍如何根据“常规提交”规范编写有效的 Git 提交信息。它概述了创建清晰、信息丰富且标准化的提交信息的基本原理。

好的提交信息应该是什么样的？

发送消息的目的是沟通。为了使沟通有效，接收者必须清楚地理解发送者想要表达的意思。因此，你需要提供上下文和充分的信息。基于此，一条好的提交消息应该传达以下内容：

1. 类型（必填）

• fix:– 适用于修复漏洞的情况。
• feat:– 当您添加新功能时适用。
• BREAKING CHANGE:- 当您引入的更改可能需要更新或升级程序的某些方面以避免中断时，此方法适用。例如，如果新资源不向后兼容，则用新资源替换已弃用的资源可能会中断功能。您还可以通过在类型（或作用域，如果可用）后使用符号“!”来指示重大更改。例如：'feat(authentication)!:'
• docs:– 适用于文档编制。

其他包括测试、杂务、重构、构建、样式等等。如果您是团队成员，可能会有需要遵守的自定义类型约定。因此，事先了解细节非常重要。

2. 范围（可选）

虽然指定作用域是可选的，但为了清晰起见，最好还是包含它。作用域明确指出代码库中受更改影响的部分，从而帮助读者理解更改的上下文。这在拥有众多贡献者的大型项目中尤为重要，能够简化协作。

3. 描述（必填）

这部分用于描述您所做的工作。务必简洁明了，直奔主题。请确保使用祈使句。例如，不要写“添加了身份验证机制”，而应该写“添加身份验证机制”。这样可以提高自动生成的变更日志和发布说明的可读性。

4. 正文（可选）

您可以在此处提供有关您已实现功能的更多信息。请使用空行将正文与描述分隔开。

5. 页脚（可选）

如果您想添加任何元数据，请将其放在页脚中。例如，如果您所做的更改解决了之前提出的问题，您可以在此处引用参考编号来表明这一点。例如：“修复 #003 ”。
您也可以在页脚中包含审阅者的姓名。

请记住，在给出描述之前，范围名称后应跟一个冒号和一个空格。此外，请注意，在页脚中包含“重大变更”字样时，区分大小写，因此应使用大写字母。

示例

• chore(Art_func): 将变量“Empty”更改为“empty”

为了与命名规则保持一致，将变量名从“Empty”更改为“empty” 。

• 修复（数据库）！：修改模式

修改数据模式，使其仅支持结构化数据。忽略所有
其他类型的数据。

• 新增功能：添加对深色模式的支持。

对于较长的消息，请使用文本编辑器，方法是运行

git commit

不使用 `-m` 标志，会打开一个编辑器，您可以在其中编写详细的提交信息。对于较短的信息，您可以只添加 `-m` 标志，然后使用终端而不是编辑器。

git commit -m "subject" -m "body"

使用多个 -m 标志可以帮助您正确地格式化邮件，将主题、正文和页脚分开。

结论

编写提交信息应该达到预期目的。为了使其清晰明了、信息丰富，建议至少包含更改的类型和描述。遵循规范的提交方式有助于维护良好的代码库，从而支持协作和各种流程的自动化。更多详细信息，请务必阅读“规范提交指南”。