如何在Github和npmjs.org上“退役”一个项目的最佳实践?

6
我是Github(以及npm)公共项目的维护者。当我创建这个项目时,它比现有的替代方案更好地解决了我的特定需求。然而,社区已经追赶并超越了我的解决方案。我甚至不再使用我创建的工具,也不想继续维护它。我已经更新了README,但仍然收到拉取请求。我应该将其删除吗?考虑到其他人正在派生它并试图做出贡献,这是否被认为是粗鲁的行为?到目前为止,我还没有成功地让其他人接受其作为维护者的责任。
我不是在寻找主观意见,而是希望获得某种共识的证据--也许是来自公认权威的文档或操作指南。谢谢。
1个回答

8
  1. 编辑README.md并添加明显的停用通知:“本项目已不再支持,请考虑使用XXX代替”。
  2. 使用npm deprecate在每次安装时放置一个停用通知。

如果其他人正在派生并尝试进行贡献,这是否被视为粗鲁行为?

是的。


特别感谢 "npm outdated"。 - cweekly
哦,该死...我的意思是“npm deprecate”,而不是“npm outdated” :) - alex
有趣的是,我也把它读成了“deprecate”(弃用),并且使用了它。 很好,“npm deprecate foo”不需要你对包做任何更改(尽管我在更新README时做了一些更改)...无论如何,再次感谢。 - cweekly

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接