如何最好地告知用户你的 Github 分支已不再维护（即它已合并）？

Question

三个月前，我fork了一个RubyGem的GitHub存储库并添加了一些功能。相当数量的人配置他们的Rails应用程序从我的GitHub存储库加载该Gem。昨天，作者合并了我的工作并发布了新的Gem。

我想通知那些继续从我的GitHub Repo拉取的人，让他们切换回主Gem。

我尝试在我的Gemspec版本中添加'post_install_message'，但是Bundler似乎不会将其用于从路径或GitHub加载的Gem。

我可以修改代码以打印警告到日志文件中，但这感觉很混乱。

我也可以只更新README，但这假定人们确实会在github.com上阅读它。

想知道是否有好的/标准/首选方法来处理这种情况？

编辑：这件事让我烦恼得够呛，所以我提交了一个拉请求，将此功能添加到通过:git或:path包含的Gem的Bundler中。我们将看看会发生什么 :)

更新：耶！https://github.com/bundler/bundler/commit/f876162b3d067ba5a3522b60e75cf13a19124f9c

- Philip Hallstrom

Answer 1

更新 README

这不是它的作用吗？

在提交信息中，摘要行应总结该事实，然后在那里编写您想要传达的任何详细信息。

在程序上，您可以编写一个已弃用的机制，警告此项目不再受到维护。并指示去哪里。

- vgoff

---

我不喜欢README的方法，因为它依赖于这样一个假设：将我的分支添加到他们的Gemfile中的人会回去阅读README。我想过时的方法是唯一好的方法，因为Bundler不会显示安装后消息。如果有可能，我很想找到一种不影响实际“代码”的方法。 - Philip Hallstrom

弃用可能仍能正常工作，因为使用您的分支的人仍将继续工作。当他们准备更新时，他们会在日志、测试等中收到消息。它不会立即破坏当前代码和版本的任何内容。此外，如果他们足够关注使用您的分支进行某项功能，则很可能也会注意到弃用通知。 - vgoff

Answer 2

通常情况下，当我在Gemfile中引用git/github时，都是有特定原因的。Bundling会在Gemfile.lock中放置一个特定的SHA。如果一切正常，我通常不会轻易运行bundle update，除非我已经查看了新内容或者有特定原因想要这样做，才会运行bundle update some-gem-from-some-github-repo以获取不同的SHA。

所以，我认为在README顶部放置一个明显的通知，说明你的更改已合并，并且你不再维护你的fork就足够了。

- carols10cents