在向包中添加示例时,我应该更新semver版本吗?

时间:2018-05-24 06:40:37

标签: github npm package versioning semantic-versioning

我正在制作一个npm包,我将其发布为版本1.0.0,因为我对公共API很满意。但现在,我正在添加一个“示例”子项目来展示如何使用该库。显然,我不会将示例项目作为库的一部分发布(它将在.npmignore中添加),但它将在我的github repo上。是否有任何语义版本控制规则?我应该更新补丁版本,次要版本还是什么都没有?

一方面,我认为我不应该更新版本,因为它不会发布到npm,因此应用程序的普通用户甚至不会注意到包中的差异。另一方面,semver规则说,当您进行文档更改时,您应该更新“补丁”或“次要”版本,即使文档未发布也是如此。

1 个答案:

答案 0 :(得分:0)

relevant spec here is #3

  
      
  1. 一旦发布版本化软件包,就不得修改该版本的内容。任何修改必须作为新版本发布。
  2.   

由于您的API中没有添加任何内容,而且显然不会发生重大变化,因此您应该修改补丁编号。