如何 semver 版本控制文档更新？

Question

我正在编写一个 REST API 包装器并提交了一项重要的文档更改。按照semver应该怎么处理？我应该更新我的 minor/patch 版本号还是完全忽略更新，因为源代码没有改变？

Answer 1

这取决于文档的变化。如果您没有突然说出 "this bug isn't a feature you can rely on and will be fixed eventually" 之类的话，您的补丁级别可能发生了变化。换句话说，如果您没有很多客户依赖于一些以前未记录的功能，那么现在显然被标记为错误，那么它就是一个补丁。但是，如果新文档的要点有效地改变了大部分客户的世界，您可能希望将其视为重大更改。

通常，在这种情况下，您会在文档中发布带有明确标记的弃用语言的小更改，然后发布删除未记录的功能或错误的重大更改，以及对文档的相关更改。

如果 none 适用于您的文档更改，则为补丁级别更改。