当 GitHub 上仅 README 发生更改时，我是否必须更新项目版本？答案

【问题标题】：Do I have to update project version when only README has changed on GitHub?当 GitHub 上仅 README 发生更改时，我是否必须更新项目版本？
【发布时间】：2014-12-07 16:11:10
【问题描述】：

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

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

社区接受的做法是什么？

如果这很重要，我将使用 Bower 来分发我的包并使用 SemVer 作为版本控制系统。

【问题讨论】：

标签： github version versioning bower semantic-versioning

【解决方案1】：

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

因此我会建议在 README 更改时发布新版本。

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

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

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

【讨论】：

谢谢，我认为这是最好的做法。

【解决方案2】：

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

这样，您将获得最新的标签，以及自该标签以来您所做的（小）提交次数。
这意味着：

如果您不想添加新标签，则不必添加新标签
但您仍保留准确参考用于交付应用程序的存储库版本。

【讨论】：