git代码提交消息格式

2025-04-11

Git 提交消息的写法有很多种规范方式,下面是一些主流的格式和推荐的最佳实践,适用于日常开发,便于团队协作和自动化工具识别。


✅ 推荐格式(基于 Angular 提交规范):

<类型>(<作用范围>): <简短描述>

<详细描述(可选)>

<footer(可选,如关闭 issue)>

💡小贴士:

  • 英文句首用小写,尽量使用动词原形(add、fix、update 等)。

  • 保持简洁明了,避免冗长。

  • 提交粒度适中,一个功能/修改一次提交。

  • 配合 issue 管理时,可以加上 Closes #issue号 自动关闭。

🚀 主流类型说明(推荐用于标准化开发流程):

类型

说明

feat

✨ 新功能、新特性(Feature)

fix

🐛 修复 Bug

docs

📝 文档修改(如 README、注释等)

style

💄 格式调整(不影响代码运行的更改,比如空格、缩进、分号等)

refactor

🔨 代码重构(既不是新功能也不是 bug 修复)

perf

⚡ 性能优化

chore

项目中不属于功能开发(feat)或 bug 修复(fix)的杂项改动。

test

✅ 添加或修改测试代码

build

📦 构建系统或外部依赖项变更(如 webpack、gulp 等)

ci

🤖 持续集成配置变更(如 GitHub Actions、Travis、Jenkins)

chore

🔧 其他不影响源代码的变更(如构建流程、依赖管理)

revert

⏪ 回滚之前的提交

merge

🔀 分支合并提交(一般 Git 自动生成)

release

🚀 发布新版本

deps

📦 升级或降级依赖

env

🌍 环境变量或配置相关变动

security

🔒 安全相关修改(如 XSS 防御、权限控制等)

i18n

🌐 国际化相关内容

ux

🖱️ 用户体验优化(如交互细节)

hotfix

🚑 紧急修复(可选扩展,用于生产环境)

备注:chore

chore 是英文单词 “杂务、例行公事” 的意思,在 Git 提交规范中,chore 表示:

项目中不属于功能开发(feat)或 bug 修复(fix)的杂项改动。


📌 常见用 chore 的场景:

场景

示例提交

修改 .gitignore

chore(gitignore): 忽略临时配置文件

更新依赖库

chore: 升级 axios 到 1.3.0

配置文件修改

chore: 调整 ESLint 配置项

脚本工具变更

chore: 添加自动打包脚本

修改 CI/CD 配置

chore(ci): 修改构建流程

更改项目说明

chore: 更新项目 README

💡 记忆小技巧:
  • 如果 不是功能(feat)

  • 也不是 修复 bug(fix)

  • 只是一些 杂项配置/环境/依赖/工具变更

📦 示例:

perf(api): 优化分页查询的 SQL 性能

fix(login): 修复用户无法登录的问题

chore: 更新依赖项到最新版本

ci(github): 添加 GitHub Actions 自动化测试流程

release: v1.3.0 版本发布
feat(api): 添加获取用户信息的接口

详细说明:使用 FastAPI 实现了 /user/info 接口,支持 token 验证。

Closes #42
fix(auth): 修复登录时的 token 过期问题
docs(readme): 补充项目部署说明
refactor(db): 抽离数据库连接逻辑为单独模块

PREV
linux源码安装python
NEXT
内容分发工具oras