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

相关推荐
sylvia_08151 天前
git add 后pull 放弃本地所有修改
git
五阿哥永琪1 天前
Git 开发常用命令速查手册
大数据·git·elasticsearch
柒壹漆1 天前
用Python制作一个USB Hid设备数据收发测试工具
开发语言·git·python
爱吃番茄鼠骗2 天前
git命令使用教程
git
黑牛先生2 天前
【Git】解决远程仓库备注错误问题
git
rockmelodies2 天前
Git冲突解决实用指南
git·git冲突
bj_zhb2 天前
Git 回退到某个 commit
git·github
凯子坚持 c2 天前
Git分支实战指南:如何优雅地管理版本、修复Bug并解决合并冲突
git·bug
openinstall全渠道统计2 天前
开发者指南:广告投放系统搭建与前后端数据打通全流程
windows·git·oracle·eclipse·sqlite·github
yunianshu2 天前
在 DevEco Studio 中查看 Git 本地更改 (Local Changes) 指南
git