如何保存版本控制文档更新？

Question

我正在编写REST API包装器，并进行了重要的文档更改。我应该如何根据semver处理此问题？因为源代码未更改，我应该更新我的次要/补丁版本号还是完全忽略更新？

Answer 1

这取决于文档的更改。如果您没有突然说出“此错误不是您可以依靠的功能，并且最终将得到解决”，则可能是补丁程序级别发生了变化。换句话说，如果您依赖于一些以前未记录的功能而没有太多的客户，那么现在显然已将其标记为错误，那么它就是一个补丁。但是，如果新文档的要旨有效地改变了很大一部分客户的世界，您可能希望将其视为一项重大变化。

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

如果所有更改均不适用于您的文档更改，则是补丁程序级别更改。