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

Question

我正在编写一个 REST API 包装器并提交了一个重要的文档更改。根据semver我应该如何处理？由于源代码没有更改，我应该更新我的次要/补丁版本号还是完全忽略更新？

标签： documentationversioningsemantic-versioning

Answer 1

这取决于文档更改。如果您没有突然说“此错误不是您可以依赖的功能并且最终将被修复”之类的话，您可能会更改补丁级别。换句话说，如果您没有很多客户依赖于一些以前未记录的功能，现在显然被标记为错误，那么它就是一个补丁。但是，如果新文档的要点有效地改变了大部分客户的世界，您可能希望将其视为一项重大变化。

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

如果这些都不适用于您的文档更改，则这是补丁级别的更改。