给你的 Git 提交加点料

2023-12-17 10:30:12

在软件开发的日常工作中，我们使用 Git 来管理代码。每次对代码进行更改时，我们都会使用 git commit 将这些更改提交到代码库中。Git 要求在提交时提供提交消息，该消息将作为更改的说明保存在提交历史中，以便将来参考。

然而，你是否深入研究过 Git 提交？或者，更确切地说，你是否考虑过如何有效地编写提交消息？

一份经过深思熟虑的提交消息不仅可以使代码历史记录更容易理解，还可以作为团队成员之间的沟通工具。通过遵循一些最佳实践，你可以编写出简洁、清晰且有用的提交消息，从而显著改善你的 Git 工作流。

遵循约定

为了确保一致性和可读性，遵循既定的约定非常重要。许多团队使用 Conventional Commits 规范，该规范定义了提交消息的结构和范围。

Conventional Commits 规范：

<type>(<scope>): <subject>

<body>

<footer>

type： 指定提交的类型，例如修复、特性、重构等。

scope： （可选）指定提交影响的代码部分。

subject： 简要提交的更改，通常以动词短语开头。

body： （可选）提供有关提交的更详细说明。

footer： （可选）包含其他相关信息，例如问题跟踪器链接或破坏性更改警告。

保持简短和简洁

提交消息应该简洁明了，让人一目了然。尽量将主旨行（<type>(<scope>): <subject>）保持在 50 个字符以内，正文段落保持在 72 个字符以内。

使用动词短语

在撰写提交消息时，使用动词短语来所做的更改。例如，使用“修复：”修复了一个错误，使用“添加：”添加了一个新功能，使用“重构：”重构了代码结构。

提供有意义的细节

除了主旨行之外，正文段落可以提供有关提交的更多详细信息。解释你做了什么，为什么做，以及更改的影响。尽可能具体，但避免冗长或不相关的细节。

使用长尾关键词

对于技术指南，使用长尾关键词可以帮助提高你的文章在搜索引擎结果页面（SERP）中的排名。长尾关键词是更具体、更具体的搜索查询，通常由三个或更多单词组成。例如，与其使用“Git 提交”作为关键词，不如使用“如何在 Git 中编写有效的提交消息”作为长尾关键词。

强调关键信息

如果你的提交包含重要的更改或破坏性修复，请在提交消息中突出显示这些信息。你可以使用大写字母、感叹号或脚注来吸引注意力。

避免重复

提交消息应该只包含有关提交本身的信息。避免重复其他地方已经记录的信息，例如问题跟踪器或代码审查工具中的描述。

编写示例

为了进一步说明，这里有一些遵循最佳实践的示例提交消息：

feat(ui): 添加新登录页面

添加了一个新的登录页面，具有改进的用户界面和更强的安全性措施。

修复(数据库): 修复了导致数据库连接失败的错误

修复了一个错误，该错误导致应用程序在连接到数据库时失败。

重构(api): 重构了 API 以提高性能和可扩展性

重构了 API 以使用更有效的数据结构和算法，从而提高性能和可扩展性。