跳到主要内容

规范

2023年02月24日
柏拉文
越努力,越幸运

一、提交格式


符合规范的Commit Message的提交格式如下,包含了页眉(header)、正文(body)和页脚(footer)三部分。其中,header是必须的,bodyfooter可以忽略。

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

二、页眉设置


页眉(header)通常只有一行,包括了提交类型(type)、作用域(scope)和主题(subject)。其中,typesubject是必须的,scope是可选的。

2.1 提交类型

提交类型(type)用于说明此次提交的类型,需要指定为下面其中一个:

Preview

2.2 作用域

作用域(scope)表示此次提交影响的范围。比如可以取值api,表明只影响了接口。

2.3 主题

主题(subject)描述是简短的一句话,简单说明此次提交的内容。

三、正文设置


正文(body)这部分不是必须的。

如果是破坏性的变更,那就必须在提交的正文或脚注加以展示。一个破坏性变更必须包含大写的文本 BREAKING CHANGE,紧跟冒号和空格。脚注必须只包含 BREAKING CHANGE、外部链接、issue 引用和其它元数据信息。例如修改了提交的流程,依赖了一些包,可以在正文写上:BREANKING CHANGE:需要重新npm install,使用npm run cm代替git commit

chore: 引入commitizen

BREANKING CHANGE:需要重新npm install,使用npm run cm代替git commit

当然,在平时的提交中,我们也可以只包含header,比如我们修改了登录页面的某个功能,那么可以这样写Commit Message

feat(登录):添加登录接口

四、页脚设置


页眉(footer)这部分不是必须的。

如果是破坏性的变更,那就必须在提交的正文或脚注加以展示。一个破坏性变更必须包含大写的文本 BREAKING CHANGE,紧跟冒号和空格。脚注必须只包含 BREAKING CHANGE、外部链接、issue 引用和其它元数据信息。例如修改了提交的流程,依赖了一些包,可以在正文写上:BREANKING CHANGE:需要重新npm install,使用npm run cm代替git commit

chore: 引入commitizen

BREANKING CHANGE:需要重新npm install,使用npm run cm代替git commit

当然,在平时的提交中,我们也可以只包含header,比如我们修改了登录页面的某个功能,那么可以这样写Commit Message

feat(登录):添加登录接口