除了LICENSE之外的哪些文件是添加到gem repo的好方法？

Question

我写了gem并将其发布到github（ex - https://github.com/randx/six）

我添加了LICENSE文件。

我经常在其他回购中看到VERSION文件 - 目标是什么？

我应该添加其他任何文件吗？

Answer 1

Greg Brown撰写的“Ruby Best Practices”第8章专门处理正确维护Ruby项目，包括目录布局，您应该包含的文件等。这本书可以在网上合法获取：

http://majesticseacreature.com/rbp-book/pdfs/rbp_1-0.pdf

Answer 2

我总是喜欢好README。阅读一个解释良好的README比阅读自动生成的RDoc手册要容易得多。 README应该解释gem的作用以及如何使用它，在README结尾处可以包含示例代码甚至一些高级示例。

另一个重要文件是历史记录或CHANGES文件。此文件应包含发行版之间主要更改的说明。它不需要包含细节，但是应该包含足够的信息，以便从版本x升级到版本y的人可以快速查看新版本（因此可以评估升级的好处）以及发生了哪些变化（因此您可以评估升级对您当前代码的潜在影响）。

有太多次我看到缺少CHANGES文件的项目，而且当你运行升级时，你几乎不知道发生了什么变化。

Answer 3

从我的角度来看，每个GitHub项目（根据您的问题，您在那里都有一个仓库）应该具有：

1. 与CI服务器（Travis CI，Circle CI等）集成
2. 带有发布/拉出请求模板的.github文件夹（例如https://github.com/zold-io/zold/tree/master/.github）
3. .gitingore以避免意外提交的临时/本地文件
4. .gitattributes用于自定义Git存储库配置（更多https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes和https://git-scm.com/docs/gitattributes）
5. .rubycop.yml
6. 将以下徽章添加到您的readme.md
   • 版本的红宝石宝石
   • 许可证详细信息
   • 每年提交活动以突出项目状态
   • 有关https://www.yegor256.com/2014/11/14/hits-of-code.html的HoC的更多信息
   • 最新版本的状态
   • 依赖状态（是否过时）
   • 显示依赖项的漏洞计数（如果有）
   • 作为代码质量标志

以上示例的项目：

• https://github.com/dgroup/docker-unittests（java）
• https://github.com/mattbrictson/gem（红宝石）