你不再维护 GitHub 仓库时应该怎么做?

3
你对于不再维护的GitHub存储库会怎样处理?
无论何种原因,一个项目开始时都会有一个GitHub存储库,并且在一段时间后它被放弃了。也许它是一个没有成功的实验。也许你用商业产品替换了它。或者可能你找到了一个类似的项目,加入了他们的努力。
在您的存储库存在的时间里,它吸引了观察者和一些forks。
那么在这个时候你该怎么做呢?有没有一种好的方式表明存储库不再维护,要么检查fork,要么选择其他项目?
4个回答

3
我会提交一个单一的commit,除了一个清楚说明你不再对项目感兴趣的README文件外,删除所有源代码(如果需要,将README的重要部分复制到最后一个提交日志消息中,使用git commit --amend命令)。
README应该解释说所有的源代码仍然可以通过历史记录获得。此外,应该描述最新代码的成熟度水平:如果它在某个地方被用于生产,应该在这里说明;如果它只是一个实验,而且你从来没有正确编译过它,那么应该用大写字母说明。在后一种情况下,也许删除代码库是有意义的。
显然,README还应包含关于你的代码的通用描述,但这应该已经在README中了。
同时,尽量在README中添加一些你期望潜在用户搜索的词语。尝试将这些词语放在说明你不再维护代码的部分附近。
这样做的原因是:
  • 任何对你的源代码感兴趣的人都仍然能够获得它(通过历史记录)
  • 任何试图盲目将你的HEAD与他的合并的人都会立即看到这是一个坏主意(所有源代码都将被删除并替换为一个README,解释为什么会发生这种情况)
我不同意如果没有人fork(并保留代码),它就一文不值的建议。也许别人没有接手的唯一原因是你的项目还没有被足够多的人看到。
如果你相信你的代码有任何价值(我指的是任何大于零的东西),那么不要删除它。只需明确表示该代码已被放弃即可。

还可以提到,在克隆存储库后,您可以使用简单的命令“git reset --hard HEAD^”删除删除代码的最后一次提交。 - Mikko Rantalainen

2

实际上,我认为你可以做的最好的事情就是简单地删除存储库。这样,过时的代码就不会在搜索结果中出现。

分布式版本控制的整个重点在于没有哪个存储库比其他存储库更重要。如果项目足够有趣,那么其中一个分叉存储库的人将成为新的社区领袖。如果没有人分叉它,那么它可能不值得保留。


0
我会在 README 文件中做一个不错的提交,基本上说明这里是为了历史参考而存在的,查看 X、Y 和 Z,以了解这段代码的去向。

0

我在我的项目名称前加上"已弃用的"前缀。Github网站上有一些关于此的帖子,但他们似乎不会改变主意。他们希望您在自述文件中放置一个说明。但我更喜欢将信息放在关系数据库中,以便您可以根据不同字段进行排序,其中之一是该项目是否活动。

我把已弃用的项目放在那里,因为有一些概念可以重复使用。这类似于你的学校作业。希望你可以从中学到一两个教训。

沃尔特


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