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

相关推荐
MinggeQingchun12 小时前
Git - 令牌登录
git
xhy_070714 小时前
Git 合并冲突怎么解决?用 AI 处理冲突的流程、Prompt 和 4 个易错点
人工智能·git·安全·prompt·ai编程·代码复审
Zhou14113617 小时前
Git_02_GitLab协作与CI_CD
git·ci/cd·gitlab
Zhou14113618 小时前
Git_03_GitFlow分支工作流
git
Flynt18 小时前
把 bug tracker 塞进 git 仓库,同步和冲突怎么解决?我把 git-bug 拆开实测了一遍
分布式·git·开源
louisgeek2 天前
Git submodule 子模块
git
imDwAaY2 天前
6篇文章讲清楚Git:Git 实用技巧:暂存现场、挑选提交与定位 Bug (5/6)
git·后端
imDwAaY2 天前
6篇文章讲清楚Git:Git 团队开发实践:从 Pull Request 到版本发布 (6/6)
git·后端
誰能久伴不乏2 天前
看懂 Git 团队协作全流程:分支、提交、PR、rebase 到底在干嘛
git