Git Commit 提交信息标准格式

Git Commit 提交信息标准格式

采用 Conventional Commits 规范,方便自动生成 ChangeLog、语义化版本号,并让团队提交信息保持一致。

格式模板

text 复制代码
<type>[optional(scope)]: <subject>

<body>

<footer>
  • Header(首行)
    • 长度 ≤ 50 字符,祈使句,首字母小写,末尾不加句号。
    • 组成:type + 可选 scope + subject
    • 示例:feat(api): add rate-limit middleware
  • 空行:Header 与 Body 之间必须空一行。
  • Body(可选) :说明 动机对比,每行 ≤ 72 字符。
  • Footer(可选)
    • 关联 / 关闭 Issue:Closes #123Refs #456
    • 破坏性变更:BREAKING CHANGE: xxx

常用 type 枚举

type 说明
feat 新功能 / 特性
fix Bug 修复
docs 文档变更
style 代码格式(不影响逻辑)
refactor 代码重构
perf 性能优化
test 测试相关
build 构建系统 / 依赖变更
ci CI/CD 配置
chore 其他杂项
revert 回滚提交

使用建议

  1. 保持原子性:一次提交只做一件事,若涉及多个 type,拆分成多次 commit。
  2. 配合工具
  3. 收益
    • 自动生成 CHANGELOG.md
    • 自动推断语义化版本号(major / minor / patch)。
    • 让 PR Review 与 git log 更清晰易读。

参考文档:Conventional Commits v1.0.0、Angular / Vue / GitLab 提交规范实践。

相关推荐
轮到我狗叫了1 天前
git - 版本控制工具 - 对应的常见命令 - 以及无需后续每次手动source conda
git
changxiang1 天前
GIT 备忘
git
DogDaoDao1 天前
Windows 开发提效工具全景指南:60+ 工具的工程化分层配置
windows·git·程序员·开发工具·powershell·everything·msys2
wdfk_prog2 天前
GitHub push 失败:如何扫描并清理 Git 历史中的大文件
git·elasticsearch·github
大明二代2 天前
使用 Traefik、cert-manager 和 DNS-01 为内网 Kubernetes 服务配置 HTTPS
git·kubernetes·flux
StarRocks_labs2 天前
从 6000+ Commit 中识别升级风险:一个 StarRocks AI 升级扫描工具的实现
starrocks·ai·commit·分析·claude code
小芒果_012 天前
git常用命令速查
大数据·git·elasticsearch
2501_930472442 天前
腾讯云助手规范化Git提交记录
git·elasticsearch·腾讯云
风尘小子2 天前
git的.gitignore文件中文件和目录配置
git
Tanner_SL3 天前
Linux笔记之GIT常用命令
linux·git