我如何判断 GitHub 代码库的质量？

Question

我经常会被指向某个Github存储库中的代码，但我很难评估是否应该信任并使用该代码。

假设这段代码是我所需的答案，我还应该检查哪些参数才能决定使用该代码是否是一个好主意？

- gardenofwine

Answer 1

您应该检查以下内容：

• 文档 - 是否有清晰的文档？您需要作者的支持才能使用代码吗？

• 活跃度 - 有时作者可能无法不断推送更新到库中，但重要的问题和拉取请求很快得到解决。常见的错误通常会在拉取请求中由其他人解决，但如果没有合并，则很难处理所有分叉。

  此外，您还应该检查仓库中的“脉搏”页面。它将显示问题、提交和发布的活动情况。

• 可扩展性 - 您可能希望对库进行不同的操作。或者您可能希望在其基础上构建一些东西。您应该检查API（公共接口）、配置以及某些组件是否可以用其他内容更改（考虑接口和组合设计模式）。

• 测试 - 单元测试非常重要。您应该为自己的应用程序编写测试。当您使用外部库时，请确保它经过了良好的测试，这样您就可以在更新或在不同的环境中使用相同的组件。如果代码未经过测试，则不应使用它。除非您自己编写了测试。

- Haralan Dobrev

---

谢谢HaralanDobrev，你给了我一些不错的指点，但@Indigon的Chrome扩展是我正在寻找的工具。 - gardenofwine

@gardenofwine 该扩展仅根据（forks和watchers数量）来评估仓库的热度。但这些指标并不足够好！如果仓库没有更新，它可能会有很多forks。如果一个好的仓库非常活跃，它仍然可能只有很少的watchers，因为人们不想要噪音。总体而言，这些指标只能显示一个仓库的受欢迎程度，却不能代表其质量。 - Haralan Dobrev

@HaralanDobrev 你说得对。目前我的扩展程序是基于流行度来排名的，但有时候流行度等同于质量。仓库的流行度可能表明代码正在不断维护和改进。然而，请记住，这个扩展程序还在开发中，最近才发布，因此还有改进的空间。 - ShayDavidson

@Indigon 如果你想衡量受欢迎程度，可以数一下星星。此外，贡献者的数量和开放/关闭的问题也可能有用。干杯 ;) - Haralan Dobrev

@HaralanDobrev 这已经在待办事项清单上了 :) - ShayDavidson

我真的不明白为什么会有没有评论的踩票。 - Haralan Dobrev

Answer 2

你可以查看我写的Chrome扩展 DevGib。它会在访问Stackoverflow问题和Github存储库之前自动评估它们，通过在链接旁边显示一个小的彩色图标。这个扩展还在开发中，但对我来说已经能够胜任工作了。

- ShayDavidson

---

只是注意到扩展的网站和存储库现在找不到了。它仍然存在于Chrome Web Store中：https://chrome.google.com/webstore/detail/devgib/pkchajlcgibonmocadnippbgjkceieeb，但我认为它不会再更新了。 - Haralan Dobrev

链接失效是因为项目已经迁移到了 Github 组织。您可以在这里找到存储库：https://github.com/ShayDavidson/DevGib，Github 页面在这里：http://code-cats-coffee.com/DevGib/虽然该项目已经有一段时间没有更新了，但它仍然在被许多我认识的人日常使用 :)。 - ShayDavidson