除了许可外，哪些文件是添加到您的宝石库中的一个好习惯？

Question

我写了gem并将其发布到github（例如-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。阅读解释清楚的自述文件比浏览自动生成的RDoc手册要容易得多。自述文件应说明gem的功能以及如何使用它，并在自述文件末尾附带示例代码，甚至包括一些高级示例。]

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

太多次，我看到缺少CHANGES文件的项目，而运行升级时您几乎无所适从。

Answer 3

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