【规范】约定式提交 2.0.0
📔 千寻简笔记介绍
千寻简笔记已开源,Gitee与GitHub搜索chihiro-notes
,包含笔记源文件.md
,以及PDF版本方便阅读,且是用了精美主题,阅读体验更佳,如果文章对你有帮助请帮我点一个Star
~
文章目录
- 【规范】约定式提交 2.0.0
-
- 📔 千寻简笔记介绍
- 1 概述
- 2 示例
- 3 *约定式提交规范
- 4 为什么使用约定式提交
- 5 FAQ
-
- 5.1 问题及建议
-
- 5.1.1 在初始开发阶段我该如何处理提交说明?
- 5.1.2 提交标题中的类型是大写还是小写?
- 5.1.3 如果提交符合多种类型我该如何操作?
- 5.1.4 这不会阻碍快速开发和迭代吗?
- 5.1.5 约定式提交会让开发者受限于提交的类型吗(因为他们会想着已提供的类型)?
- 5.1.6 这和 SemVer 有什么关联呢?
- 5.1.7 我对约定式提交做了形如 `@jameswomack/conventional-commit-spec` 的扩展,该如何版本化管理这些扩展呢?
- 5.1.8 如果我不小心使用了错误的提交类型,该怎么办呢?
- 5.1.9 当使用了 *不在* 规范中的类型时,例如将 `feat` 写成了 `feet`
- 5.1.10 所有的贡献者都需要使用约定式提交规范吗?
- 5.1.11 约定式提交规范中如何处理还原(revert)提交?
1 概述
1.1 约定式提交规范
- 约定式提交规范是一种基于提交信息的轻量级约定。 它提供了一组简单规则来创建清晰的提交历史; 这更有利于编写自动化工具。 通过在提交信息中描述功能、修复和破坏性变更, 使这种惯例与 SemVer 相互对应。
提交说明的结构如下所示:
- 原文:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
- 译文:
<类型>[可选 范围]: <描述>
[可选 正文]
[可选 脚注]
1.2 提交说明
提交说明包含了下面的结构化元素,以向类库使用者表明其意图:
- fi