编写更好的 git 提交消息的模式

这是我随身携带的一份指南，每当我怀疑自己是否在撰写良好的提交信息并符合我所交付内容的上下文时，我都会参考它。

好的提交应该完成以下句子

正确格式的 Git 提交主题行应该始终能够完成以下句子：
If applied, this commit <will your subject line here>

提交示例

请参阅下面的提交示例：

[type](optional scope): [subject]

[optional body]

[optional footer]

类型

必须是下列之一：

• 构建 - 构建相关的更改
• ci - CI 相关变更
• 琐事 - 构建过程或辅助工具更改
• docs - 仅文档更改
• feat - 一项新功能
• 修复 - 错误修复
• perf - 提高性能的代码更改
• 重构 - 既不修复错误也不添加功能的代码更改
• 恢复 - 恢复原状
• 样式 - 标记、空格、格式、缺少分号……
• 测试 - 添加缺失的测试

范围

可以为提交的类型提供范围，以提供额外的上下文信息，并将其包含在括号内，例如，feat（解析器）：添加解析数组的能力。

主题

主题包含对变更的简洁描述：

• 使用祈使句、现在时：“change”，而不是“changed”或“changes”
• 末尾没有点 (.)。

身体

与主语一样，使用祈使句和现在时：“change”，而不是“changed”或“changes”。正文部分应包含改变的动机，并将其与之前的行为进行对比。

优秀提交信息的 7 条规则：

1. 用空行将主题与正文分开
2. 将主题行限制为 50 个字符
3. 摘要采用现在时。不大写。
4. 不要以句号结尾
5. 在主题行中使用祈使语气
6. 正文在 72 个字符处换行
7. 使用正文来解释什么、为什么以及如何

提交模板

转到我的 git 提交模板

参考

• 如何编写 Git 提交消息（作者：Chris Beams）
• 为什么要使用约定式提交
• @commitlint/config-conventional
• 提交信息指南