Git 完整的提交规范教程-明恒博客

当前文章收录状态：

查询中...

约定式提交规范

本文中的关键词 “必须（MUST）”、“禁止（MUST NOT）”、“必要（REQUIRED）”、“应当（SHALL）”、“不应当（SHALL NOT）”、“应该（SHOULD）”、“不应该（SHOULD NOT）”、“推荐（RECOMMENDED）”、“可以（MAY）” 和 “可选（OPTIONAL）”

每个提交都必须使用类型字段前缀，它由一个名词构成，诸如 feat 或 fix ，其后接可选的范围字段，可选的 !，以及必要的冒号（英文半角）和空格。
当一个提交为应用或类库实现了新功能时，必须使用 feat 类型。
当一个提交为应用修复了 bug 时，必须使用 fix 类型。
范围字段可以跟随在类型字段后面。范围必须是一个描述某部分代码的名词，并用圆括号包围，例如： fix(parser):
描述字段必须直接跟在 <类型>(范围) 前缀的冒号和空格之后。描述指的是对代码变更的简短总结，例如： fix: array parsing issue when multiple spaces were contained in string 。
在简短描述之后，可以编写较长的提交正文，为代码变更提供额外的上下文信息。正文必须起始于描述字段结束的一个空行后。
提交的正文内容自由编写，并可以使用空行分隔不同段落。
在正文结束的一个空行之后，可以编写一行或多行脚注。每行脚注都必须包含一个令牌（token），后面紧跟 : 或 # 作为分隔符，后面再紧跟令牌的值脚注的令牌必须使用 – 作为连字符，比如 Acked-by (这样有助于区分脚注和多行正文)。有一种例外情况就是 BREAKING CHANGE，它可以被认为是一个令牌。
脚注的值可以包含空格和换行，值的解析过程必须直到下一个脚注的令牌/分隔符出现为止。
破坏性变更必须在提交信息中标记出来，要么在 <类型>(范围) 前缀中标记，要么作为脚注的一项。
包含在脚注中时，破坏性变更必须包含大写的文本 BREAKING CHANGE，后面紧跟着冒号、空格，然后是描述，例如： BREAKING CHANGE: environment variables now take precedence over config files 。
包含在 <类型>(范围) 前缀时，破坏性变更必须通过把 ! 直接放在 : 前面标记出来。如果使用了 !，那么脚注中可以不写 BREAKING CHANGE:，同时提交信息的描述中应该用来描述破坏性变更。
在提交说明中，可以使用 feat 和 fix 之外的类型，比如：docs: updated ref docs. 。
工具的实现必须不区分大小写地解析构成约定式提交的信息单元，只有 BREAKING CHANGE 必须是大写的。
BREAKING-CHANGE 作为脚注的令牌时必须是 BREAKING CHANGE 的同义词。

为什么使用约定式提交

提交类型	标题	描述	发布	包含在变更日志中
feat	特征	一个新功能	minor	true
fix	Bug修复	错误修复	patch	true
docs	文档	仅文档更改	patch如果scope是readme	true
style	风格	不影响代码含义的更改（空格、格式、缺少分号等）	–	true
refactor	代码重构	既不修复错误也不添加功能的代码更改	–	true
perf	性能改进	提高性能的代码更改	patch	true
test	测试	添加缺失的测试或纠正现有的测试	–	true
build	构建	影响构建系统或外部依赖项的更改（示例范围：gulp、broccoli、npm）	patch	true
ci	持续集成	对我们的 CI 配置文件和脚本的更改（示例范围：Travis、Circle、BrowserStack、SauceLabs）	–	true
chore	家务活	不修改 src 或测试文件的其他更改	–	true
revert	还原	恢复之前的提交	–	true

1 本站网络名称： 明恒博客

2 本站永久网址： www.zym88.cn

3 本站的文章部分内容可能来源于网络，仅供大家学习与参考，如有侵权，请联系站长进行删除处理。
4 本站一切资源不代表本站立场，并不代表本站赞同其观点和对其真实性负责。
5 本站一律禁止以任何方式发布或转载任何违法的相关信息，访客发现请向站长举报。
6 本站资源大多存储在云盘，如发现链接失效，请联系我们我们会第一时间更新。

THE END