当只在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 Pages,可以派上用场.