如何发送版本控制文档更新？

Question

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

Answer 1

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

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

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