除了 LICENSE 之外，哪些文件是添加到您的 gem 存储库的好习惯？

Question

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

我添加了许可证文件。

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

我还应该添加其他文件吗？

Answer 1

Greg Brown 所著的《Ruby 最佳实践》第 8 章专门讨论如何正确维护 Ruby 项目，包括目录布局、应包含的文件等。该书可在此处合法在线获取：

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

Answer 2

我一直喜欢好的README。阅读解释良好的自述文件比浏览自动生成的 RDoc 手册要容易得多。自述文件应该解释 gem 的作用以及如何使用它，并在自述文件的末尾包含示例代码，甚至一些高级示例。

另一个重要文件是历史记录或 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< /code>
6. 将以下徽章添加到您的 readme.md

• 版本你的红宝石宝石
• 许可证详细信息
• 每年提交活动以突出项目状态
• 有关 HoC 的更多信息，请参见此处 https://www.yegor256.com/2014/11/14/hits-of-code.html
• 
  最新版本的状态
• 依赖项的状态（是否已过时）
• 
  显示依赖项的漏洞计数（如果有）
• 
  
  <图片src="https://api.codacy.com/project/badge/Grade/a44d11a620da4ff0a6ff294ff9045aa3" alt="Codacy 徽章">
  
  
  作为代码质量徽章

上面示例中的项目：

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