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

相关推荐
摇滚侠9 小时前
VScode 提交代码 Git
git
YuforiaCode11 小时前
移除原有 Git 仓库关联,在IDEA中重新初始化 Git 并推送到新仓库(详细图解、包含相关问题的解决办法)
git
UIUV11 小时前
Git程序员入门笔记:从零开始掌握分布式版本控制
git
星光不问赶路人11 小时前
彻底清理 Git 分支:从查看到批量删除无效分支的全流程指南
git·github
如果是君16 小时前
【git使用】ubuntu下利用git工具提交一个工程
linux·git·ubuntu
吃鱼吃鱼吃不动了17 小时前
常用的 git 命令
git
迷路爸爸18018 小时前
Git Commit Message 规范:写出清晰、可维护的提交记录
git·python
前端赵哈哈18 小时前
Git 本地仓库操作指南:将未提交文件复刻至新分支(无需关联远端)
前端·git·github
神秘的猪头18 小时前
git应用初体验
git
麻辣璐璐1 天前
【新手小白版】Gerrit使用教程
git·gerrit·新手