我正在 GitHub 上编辑我的一个开源项目，我想在README.md.
每次我对 README 文件或文档进行一些小的更改（没有任何实际代码更改）时，我是否必须更新库版本？
社区接受的做法是什么？
如果它很重要，我将使用Bower分发我的包和SemVer作为版本控制系统。
问问题
2679 次
2 回答
10
自述文件是代码库的一部分。它应该描述代码的当前（= 当前提交）状态。开发人员可能会在 GitHub 环境之外读取它，例如从node_modules他们硬盘上的目录中读取它，并期望它是最新的。
因此，我建议在README更改时发布新版本。
它通常只会导致补丁数量增加。但是请记住，当将某些内容标记为已弃用时，必须发布一个新的次要版本（SemVer v2.0.0中的第 7 段）。
如果您打算进行大量更改，有两种方法可以避免过于频繁地发布：
- 在分支中进行更改。合并到
master这里和那里，发布一个新的补丁版本。 - 将文档（或其中的一部分）移到其他地方。GitHub Wiki 或一个简单的网页，例如使用 GitHub Pages，可以派上用场。
于 2014-10-15T15:01:56.903 回答
2
您可以将 的内容作为库版本包括在内，如git describe --all --long如何获取 Git 内部版本号并将其嵌入文件中所述？（使用git describe）。
这样，您将获得最新的标签，以及自该标签以来您所做的（小）提交次数。
这意味着：
- 如果您不想添加新标签，则不必添加
- 但是您仍然保留了用于交付应用程序的 repo 版本的准确参考。
于 2014-10-13T06:37:35.473 回答