MorJS Git Commit FAQ

2024-01-24 09:45 更新

在初始开发阶段我该如何处理提交说明?

我们建议你按照假设你已发布了产品那样来处理。因为通常总 有人 使用你的软件,即便那是你软件开发的同伴们。他们会希望知道诸如修复了什么、哪里不兼容等信息。

提交标题中的类型是大写还是小写?

大小写都可以,但最好是一致的。

如果提交符合多种类型我该如何操作?

回退并尽可能创建多次提交。约定式提交的好处之一是能够促使我们做出更有组织的提交和 PR。

这不会阻碍快速开发和迭代吗?

它阻碍的是以杂乱无章的方式快速前进。它助你能在横跨多个项目以及和多个贡献者协作时长期地快速演进。

约定式提交会让开发者受限于提交的类型吗(因为他们会想着已提供的类型)?

约定式提交鼓励我们更多地使用某些类型的提交,比如 ​fixes​。除此之外,约定式提交的灵活性也允许你的团队使用自己的类型,并随着时间的推移更改这些类型。

这和 SemVer 有什么关联呢?

fix​ 类型提交应当对应到 ​PATCH​ 版本。​feat​ 类型提交应该对应到 ​MINOR​ 版本。带有 ​BREAKING CHANGE​ 的提交不管类型如何,都应该对应到 ​MAJOR​ 版本。

我对约定式提交做了形如 ​@jameswomack/conventional-commit-spec​ 的扩展,该如何版本化管理这些扩展呢?

我们推荐使用 SemVer 来发布你对于这个规范的扩展(并鼓励你创建这些扩展!)

如果我不小心使用了错误的提交类型,该怎么办呢?

当你使用了在规范中但错误的类型时,例如将 ​feat​ 写成了 ​fix

在合并或发布这个错误之前,我们建议使用 ​git rebase -i​ 来编辑提交历史。而在发布之后,根据你使用的工具和流程不同,会有不同的清理方案。

当使用了 不在 规范中的类型时,例如将​ feat​ 写成了 ​feet

在最坏的场景下,即便提交没有满足约定式提交的规范,也不会是世界末日。这只意味着这个提交会被基于规范的工具错过而已。

所有的贡献者都需要使用约定式提交规范吗?

并不!如果你使用基于 squash 的 Git 工作流,主管维护者可以在合并时清理提交信息——这不会对普通提交者产生额外的负担。 有种常见的工作流是让 git 系统自动从 pull request 中 squash 出提交,并向主管维护者提供一份表单,用以在合并时输入合适的 git 提交信息。

约定式提交规范中如何处理还原(revert)提交?

还原提交(Reverting)会比较复杂:你还原的是多个提交吗?如果你还原了一个功能模块,下次发布的应该是补丁吗?

约定式提交不能明确的定义还原行为。所以我们把这个问题留给工具开发者, 基于 类型 和 脚注 的灵活性来开发他们自己的还原处理逻辑。

一种建议是使用 ​revert ​类型,和一个指向被还原提交摘要的脚注:

revert: let us never again speak of the noodle incident

Refs: 676104e, a215868


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号