如何写 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
相关推荐
武昌库里写JAVA3 小时前
SpringBoot+Vue 项目介绍
java·javascript·git·sql·ai
杨凯凡12 小时前
IT日报|2026-11-20:欧盟 AI 网络攻击、Valkey 9.2、GitHub 企业迁移
人工智能·github
TunerT_TQ13 小时前
Terraform OCI Provider 2026:工具链的骨架清晰可见,CRUD 的肌肉必须由你亲自验证
github
prince_zxill13 小时前
把 17 个散文件装进一个文件夹:拆解 claude-plugins-official 的插件打包术(47,413 Star 实测)
python·github·agent·mcp·claude code
wflynn13 小时前
GitHub 日榜趋势速报 | 2026-11-20
开源·github
TunerT_TQ15 小时前
【开源评测】google-labs-code/stitch-skills:从设计交接到可检查的组件产物
github
一条Go17 小时前
探测规则:为什么它是告警规则的一种,而不是独立的任务体系
后端·架构·github
一条Go17 小时前
开源新生代雷达 · 第 17 期
github
怕浪猫17 小时前
2026 GitHub 最火的 10 个视频制作与剪辑开源项目:AI 出片、代码生视频、无损剪辑怎么选(附实测截图)
github
dong_junshuai1 天前
每天一个开源项目#162 NGINX:流式响应背后的缓冲、背压与重试
github