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 提交规范实践。

相关推荐
Patrick_Wilson13 小时前
Git Worktree 原理详解:从 objects / refs 看懂多分支并行与多 Agent 协作
git·面试·ai编程
yaoxiaoganggang13 小时前
克隆 Superpowers 的规则库到你的本地(或者直接作为 Git Submodule)
人工智能·经验分享·git·ai编程
Python私教15 小时前
用 Claude Code 做大型重构不翻车:分批+Git 兜底+验证闭环的实战流程(2026)
git·重构·ai编程·代码重构·工程实践·claude code
Shawn Dev16 小时前
团队协作中的 Git Tag 最佳实践:从入门到精通
大数据·git·elasticsearch
独隅18 小时前
Git/GitHub/GitLab/Gitee 核心对比指南
git·gitlab·github
佛山个人技术开发18 小时前
GitCode个人技术开发者总结完整使用指南
windows·git·svn·github·gitcode
江华森19 小时前
基于 Git 的自动集成交付(Git-Driven CI/CD)实战
git·ci/cd
Dontla20 小时前
.gitkeep文件作用(让Git追踪空目录,使该目录能被纳入版本控制)!.gitkeep
大数据·git·elasticsearch
shandianchengzi20 小时前
【记录】VSCode|Windows 下 VS Code 配置 Git Bash 为默认终端完整教程
windows·git·vscode·bash
EleganceJiaBao20 小时前
【Git】现代开发工作流(Main + Feature Branch)
git·github