GIT 提交规范

提交格式

bash 复制代码
type: subject

<Body>

<Footer>

type

用于说明 commit 的提交类型(必须是以下几种之一)。

  • feat 新增功能
  • fix 修复 bug
  • docs 文档变更
  • style 代码格式(不影响功能,例如空格、分号等格式修正)
  • refactor 代码重构
  • perf 改善性能
  • test 测试
  • build 变更项目构建或外部依赖(例如 scopes: webpack、gulp、npm 等)
  • chore 变更构建流程或辅助工具
  • revert 代码回退

subject

  • subject 是本次 commit 的简洁描述,长度约定在 50 个字符以内,通常遵循以下几个规范:
  • 用动词开头,第一人称现在时表述,例如:change 代替 changed 或 changes
  • 第一个字母小写
  • 结尾不加句号(.)

Body

  • body 是对本次 commit 的详细描述,可以分成多行。(body 可省略)
  • 跟 subject 类似,用动词开头,body 应该说明修改的原因和更改前后的行为对比。
  • 如果本次提交的代码是突破性的变更 或关闭缺陷,则 Footer 必需,否则可以省略。

本规范省略了 scope 部分,比如 type(<scope>): subject,因为我们在实际项目中使用了 scope 发现,还得有单独的文档维护 scope 列表,否则很容易乱写,比如一会儿写表格,一会儿写 table,所以干脆不再对其进行限定。

相关推荐
Demons_kirit7 小时前
CTFHub 信息泄露通关笔记:Git泄露 Log - 教程
笔记·git·网络安全
鬼手点金14 小时前
构建有效 Agent 的核心原则
java·人工智能·git·学习·自动化
索西引擎15 小时前
Git 大文件阻断推送的成因与历史重写修复
git
csdn2015_16 小时前
git 合并分支
大数据·git·elasticsearch
91440623217 小时前
mac Git 账户切换问题
git·macos
留岁17 小时前
Git 命令行学习记录
git·学习·elasticsearch
笨笨饿18 小时前
#142_VS Code.map文件插件的用法
git·python·stm32·单片机·嵌入式硬件·物联网·vim
鬼手点金19 小时前
如何选择模型
java·前端·人工智能·git·深度学习
余槐i19 小时前
Claude Code Skills 放对目录却不生效:插件启用顺序与缓存的三个坑
git·开发工具·ai agent·mcp·claude code
程序员差不多先生2 天前
Anthropic 用 5 个月重写了 Git:当 AI Agent 把版本控制系统逼到墙角
人工智能·git·elasticsearch·deepseek v4 pro·kimi k3·glm 5.3·qwen3.7 max