如何写 commit message？

前言

每次写 commit message 时，都会纠结用什么动词，格式应该什么样，所以决定总结一下。

查了一下，还是挺复杂的。因为只面向我个人日常使用，所以只进行一些简单的、适合我的总结。

正文

message 分为两部分，type 和 subject。

1）type

用于说明 commit 的类别，只允许使用下面 7 个标识。

• feat：新功能，为用户添加新的特性或功能（不包括构建脚本的新功能，像是 Dockerfile、环境配置、CI/CD 配置文件等）。
  示例：添加用户登录功能。
• fix：修复用户遇到的 bug（不包括构建脚本的修复）。
  示例：修复用户界面显示错误。
• docs：文档变更，如更新 README、API 文档或注释。
  示例：添加项目安装指南。
• style：代码格式化或样式调整，不影响功能（例如缩进、加分号）。
  示例：统一代码缩进为 2 个空格。
• refactor：重构生产代码，优化结构但不更改功能（例如重命名变量）。
  示例：将函数名从 getData 改为 fetchData。
• test：添加或重构测试代码，不影响生产代码。
  示例：为登录功能添加单元测试。
• chore：杂项任务，如更新构建工具、依赖或配置，不影响生产代码。
  示例：修改 Dockerfile。

另外注意不要大写开头字母。

2）subject

是 commit 目的的简短描述，不超过50个字符。有以下几个注意点：

• 以动词开头，使用第一人称现在时，比如 change，而不是 changed 或 changes；
• 第一个字母小写；
• 结尾不加句号（.）。

示例（日常积累）

• docs: add notes for Redis Application Chapter 1
• chore: update .gitignore to include .ipynb_checkpoints
• chore: remove redundant .ipynb_checkpoints folder

参考

1. Commit message 和 Change log 编写指南
2. vue-lib contribution guidelines