在开发人员的日常工作中,提交代码到 Git 是必不可少的动作。代码提交时的消息该怎么写呢?最基本的原则是:如果团队有 commit 格式要求,就遵循该要求。这一点与代码风格是一样的。commit 消息的格式没有绝对的好与坏,最重要的是保持一致性。
如果团队没有具体的格式要求,可以参考下面的一些建议。
消息应该分成主题和内容两个部分,两部分用一个空行分隔。主题部分对 commit 的内容进行简要说明,不宜过长;内容部分应该具体描述所做的修改,以及进行修改的原因。
关于提交消息的格式,有一个比较流行的规范,称为约定式提交。约定式提交对提交信息做了一些约定,方便自动化工具进行处理。
约定式提交使用下面的格式:
<类型>[可选 范围]: <描述>
[可选 正文]
[可选 脚注]
约定式提交由 3 个部分组成,分别是类型和描述、正文和脚注,其中正文和脚注是可选的。
第一个部分是类型和描述。类型是 commit 的分类。常用的类型有如下几种:
fix
表示 bug 修复。feat
表示