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,所以干脆不再对其进行限定。

相关推荐
Brookty4 小时前
Git与GitHub系统学习|本地Git工作模型:终端与进程、CWD、HEAD/Index/工作树及Git对象
git·github
2301_7671139819 小时前
点过“不再询问”就要检查:Claude Code权限文件也可能存着密钥
git·信息安全·claude code
江屿风1 天前
【Git-组件】【Git入门:从文档灾难到版本掌控】流食般投喂
运维·笔记·git·组件·版本控制
程序员沉梦听雨1 天前
【Git】fork工作流与上游同步
git
高调的涵涵4 天前
删了1.2GB,.git仍是1.2GB
git
程序员沉梦听雨4 天前
【Git】git-submodule子模块管理
git
全栈陈序员5 天前
Git】从入门到精通(八)—— git log:查看提交历史
大数据·git·elasticsearch
7177775 天前
Git自建用什么工具比较好:Gitea、Forgejo、GitLab CE与Gitee的选型对比
git·gitlab·gitea
lsc_blog6 天前
年底还在招的岗位,先确认缺口和到岗要求
git·缓存·ci/cd·职场和发展·github
全栈陈序员6 天前
【Git】从入门到精通(十一)—— git reset 三种模式详解
git·elasticsearch