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

相关推荐
码农小白-RMS31 分钟前
cursor-执行git指令(vscode同理)
git
℘团子এ3 小时前
git中,将新项目推送到新建的远程仓库
git
gitboyzcf3 小时前
Git 常用命令
前端·git·后端
哈里谢顿4 小时前
Git 最实用的四个还原命令详解
git
xiAo_Ju19 小时前
git hooks配置
git
mit6.82421 小时前
[Git] 如何拉取 GitHub 仓库的特定子目录
git·github
许心月1 天前
Git#revert
git
军军3601 天前
Git大型仓库的局部开发:分步克隆 + 指定目录拉取
前端·git
间彧1 天前
Git命令速查表
git