如何编写有效且有用的 Git 提交消息

提交消息是版本控制系统（如Git）中每个提交的简短描述。当您提交项目文件的更改时，应提供一条解释这些更改做了什么或为什么进行这些更改的消息。

提交消息作为一种文档和沟通形式，对于维护项目的清晰有序的版本历史起着至关重要的作用。学习如何编写良好的提交消息，您的团队成员将更加欣赏您的工作。

良好提交消息的结构

一个良好提交消息的示例包括四个部分：类型、描述、正文和页脚。

如下所示：

<类型><type>: <描述><description>

[可选正文][optional body]

[可选页脚][optional footer]

类型

类型描述了当前提交所做的更改类型。您可以使用适合您情况的任何系统。例如，以下是一些示例关键词，您可以使用它们来表示每种类型的更改，以及示例用法：

feat：您的更改引入了一个新功能。
fix：您修复了一个错误。
refactor：您对代码进行了重构，但没有修复错误或添加新功能。
test：您进行任何与测试相关的更改。例如，当您使用Jest或其他测试框架编写测试时。
chore：与修复、功能或测试无关的更改。例如，更新依赖项。
docs：当您更新文档时。
style：对代码含义无影响的更改，例如添加空格、缺少分号等。
perf：与性能改进相关的更改。
build：对影响构建文件的更改。
ci：与持续集成相关的更改。
revert：还原到以前的提交。

描述

提交消息的“描述”是对提交所做更改的简明扼要摘要。它作为捕捉提交要点的标题。

在编写描述时，请牢记以下事项：

使其足够清晰和具体，以便一目了然地描述提交内容。
保持简洁明了。最好将其限制在50个字符或更少。
使用现在时态进行写作，即使您描述的是已经进行的更改。
在写作时使用命令语气。
首字母大写。
不要以句号结尾。

例如：

feat: Implement dark mode toggle for home page

此示例展示了如何为实现暗黑模式的提交编写描述。它使用feat类型，因为它引入了一个新功能。

正文（可选）
提交消息的正文部分提供有关提交中所做更改的额外细节和背景。您并不总是需要正文，但它可以提供更多信息，解释更改的原因或描述任何技术考虑因素。

在编写提交消息的正文部分时，请注意以下事项：

Git不会自动换行文本，因此在编写正文时，请在72个字符处手动换行。这样可以给Git足够的空间缩进文本，使其更易读。
使用正文来解释更改的内容、为什么进行更改以及更改的理由。
在描述行和正文之间留空行，以使Git能够区分它们。
如果提交引入了多个更改或影响代码库的不同部分，请考虑使用项目符号或段落来分解修改。这样可以提高可读性，并帮助读者了解提交的不同方面。

例如：

feat: Add GitHub as an OAuth provider

Integrate GitHub as an OAuth provider to enable seamless 
authentication with GitHub accounts.

- Implement OAuth authentication flow with GitHub API
- Configure necessary endpoints and settings for GitHub authentication
- Update user interface to include GitHub login option

上面的示例展示了一个良好的Git提交消息，用于将GitHub添加为应用程序的OAuth提供程序。该提交消息包含一个简明的摘要行（50个字符或更少），一个更详细的解释性文本（约72个字符换行），以及用于提供附加信息的项目符号。

页脚（可选）
提交消息中的页脚部分是提供与提交相关的附加信息或元数据的可选部分。它通常位于正文部分之后，由一个空行分隔。页脚可以包含各种类型的信息，例如与相关问题的引用、标签或特殊说明。

在引用问题、拉取请求或其他相关项时，请使用您项目的问题跟踪系统所要求的适当语法或格式。这样可以确保引用得到正确识别和链接。

例如：

feat: Add GitHub as OAuth provider

Integrate GitHub as an OAuth provider to enable seamless 
authentication with GitHub accounts.

- Implement OAuth authentication flow with GitHub API
- Configure necessary endpoints and settings for GitHub authentication
- Update user interface to include GitHub login option

Resolves: #123
See also: #456, #789

添加提交消息

您可以使用-m标志后跟用引号括起来的提交消息来编写提交消息（可选但建议使用）。

-m标志适用于简短的提交消息，通常包括类型和描述。

例如：

git commit -m "chore: Change linter to ESlint"

但是，如果您的提交消息需要更多细节，比如正文和页脚，最好在文本编辑器或集成开发环境中编写提交。

另外，您可以将长的提交消息写在一个文本文件中，并使用–file标志将提交消息指定为文本文件的内容。

例如：

git commit --file commit_message.txt

运行上述命令时，git将使用文件的内容作为提交消息。

您还可以告诉git打开您的默认编辑器来编写更长的消息。如果您设置了GIT_EDITOR或EDITOR环境变量，当您运行一个简单的git commit命令时，git将打开该程序。

为什么要编写好的提交消息

编写良好的提交消息对于有效的协作和代码维护至关重要。清晰和描述性的消息有助于理解、调试和代码审查。它们甚至可以为项目文档或发布说明做出贡献。

它们促进了知识共享、顺畅的入职以及支持版本控制。优先考虑质量良好的提交消息可以增强开发过程并确保代码库的可维护性。

推荐：像高级工程师一样使用 Git https://www.linuxmi.com/git-used-by-senior-engineers.html

The post 如何编写有效且有用的 Git 提交消息 first appeared on Linux迷.