当只在GitHub上更改README时，是否必须更新项目版本？

Question

我正在GitHub上编辑我的一个开源项目，我想在README.md中替换链接（指向演示）。

每次我对README文件或文档进行一些细微更改（没有任何实际代码更改）时，是否必须更新库版本？

社区接受的做法是什么？

如果它很重要，我使用 Bower 分发我的软件包， SemVer 作为版本控制系统。

Answer 1

README 文件是您的代码库的一部分。它应该描述代码的当前（=当前提交）状态。开发人员可能会在GitHub环境之外阅读它，例如从他们硬盘上的node_modules目录开始，期待它是最新的。

因此，当 README 更改时，我建议发布新版本。

通常会导致补丁号增加。但请记住，在将某些内容标记为已弃用时，必须发布新的次要版本（SemVer v2.0.0中的第7段）。

如果您计划进行大量更改，有两种方法可以避免过于频繁地发布：

• 在分支中进行更改。在这里和那里合并到master，发布一个新的补丁版本。
• 将文档（或其中的一部分）移动到其他位置。 GitHub Wiki或简单的网页，例如使用GitHub页面，可以派上用场。

Answer 2

您可以在How can I get the Git build number and embed it in a file?（使用git describe）中说明git describe --all --long的内容作为库版本。

这样，您将获得最新的标记，以及自该标记以来您执行的（小）提交的数量 这意味着：

• 如果您不想
，则无需添加新标签
• 但您仍然保留完全引用用于投放应用的repo版本。