我知道你很急但你先别急Git Commit Message Conventions

有时在Git提交时很着急直接写 update,这样会导致之后看代码根本不知道做了啥。有时回滚就相当麻烦

推荐写法

# 只有一行,通常不超过50个字符
# 包括三个字段:type(必需)、scope(可选)和subject(必需)

<type>(<optional scope>): <subject>

说明

1、type 用于说明 commit 的类别,只允许小写字母,通常使用下面标识

  • build:构建相关
  • chore:构建过程、配置文件或辅助工具的变动
  • ci:持续集成相关
  • docs:文档(documentation)
  • feat:新功能(feature)
  • fix:修补 bug
  • perf:性能优化或算法优化
  • refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
  • revert:回滚
  • style:格式相关(不影响代码运行的变动)
  • test:测试相关

注:随着时间迁移可能会有其他出现

2、scope (可选的)通常用来说明本次提交覆盖的修改范围,如:某 Controller 或 Model

3、subject 本次提交修改内容

例子

feat(user): verify email

fix(sms): token 验证变量丢失

test: jeeinn_com 网站登录

完整写法

<type>(<optional scope>): <subject>
// 空一行
<optional body>
// 空一行
<optional footer>

Git 提交规范参考:commitlint/@commitlint/config-conventional

Author: thinkwei

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注