Documentation 如何更新版本控制文档?

Documentation 如何更新版本控制文档?,documentation,versioning,semantic-versioning,Documentation,Versioning,Semantic Versioning,我正在编写一个RESTAPI包装器,并提交了一个重要的文档更改。我应该如何处理这件事?我应该更新次要/修补程序版本号还是完全忽略更新,因为源代码没有更改?这取决于文档的更改。如果你没有突然说“这个bug不是一个你可以依赖的功能,最终会被修复”,那么很可能你有一个补丁级别的改变。换句话说,如果你没有太多的客户依赖于一些以前未记录的特性,那么现在显然被标记为bug,那么它就是一个补丁。但是,如果新文档的要点有效地改变了大部分客户的世界,那么您可能希望将其视为一个突破性的变化 通常,在这种情况下,您会

我正在编写一个RESTAPI包装器,并提交了一个重要的文档更改。我应该如何处理这件事?我应该更新次要/修补程序版本号还是完全忽略更新,因为源代码没有更改?

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

通常,在这种情况下,您会在文档中以带有明确标签的弃用语言的小更改发布,然后发布一个突破性的更改,该更改会删除未记录的功能或bug,以及文档的相关更改

如果这些都不适用于您的文档更改,那么这是补丁级别的更改