如何为Git Commit进行备注？

0x00 前言

无论是个人开发还是团队开发，我们都很有可能用到版本管理工具如git、svn等，使用它们我们可以针对每次提交的代码进行备注，以便日后追溯或查看时容易理解当时变更代码的目的。

git commit -m "进行了代码变更"

相比于个人以随心所欲的方式去备注自己的每一次提交，我们希望项目开发者以一种规范的备注风格让项目成员能够更方便地理解代码变更。

0x01 提交备注的规范

提交备注（Commit Message）可以分文三个部分：

• Header

  备注的标题行，描述主要变更内容

• Body

  主体内容，以更详细的文本说明变更目的、方法、风险等

• Footer

  尾部内容，附带可能需要新创建或者关闭的issue的链接

其中Body和Footer往往可以省略，Header部分则是必需。

提交备注的Header部分又可以分为type、scope、subject三个部分。

(1) type

用于说明提交的类别，是必需部分。可以用如下关键字标识提交类别：

• feat: 新功能(feature)
• fix: 修复(bug)
• docs: 文档(document)
• style: 格式（不影响代码运行的变动）
• refactor: 重构（既不是新增功能，也不是修复bug的改动）
• test: 增加测试（单元测试、业务测试）
• chore: 构建过程或辅助工具的变动
• perf: 性能优化相关变动
• revert: 代码回滚到上一个版本
• …

type的标识会影响change log的内容。

(2) scope

用于说明提交影响的范围，如数据层(DAO)、控制层(Controller)、视图层(View)

(3) subject

对提交目的进行简短描述。

编写subject时以动词开头、首字母小写且结尾无句号

参考资料

本文感谢以下作者/团队的分享：

• 阮一峰：Commit message 和 Change log 编写指南
• 阿里开发者: 如何规范你的Git commit？
• feflowGit Commit 规范