多年来，我看到一些人对 docrails 究竟是什么以及它与 Ruby on Rails 文档的关系存在困惑。
这篇博文将解释您想了解的关于该项目这方面的一切。
docrails 是 Ruby on Rails 的一个分支，具有公开写入权限，任何人都可以提交文档修复。
如果您看到拼写错误，想纠正事实错误，补充现有文档，添加有用的示例……在 docrails 出现之前，您必须提交一个拉取请求（或者当时等效的操作）并遵循常规工作流程才能被接受。docrails 允许您克隆仓库，编辑，然后提交。完成！
代码库的更改在推送之前需要审核。每个新的功能或 bug 修复都需要核心团队成员的视角和责任来做出决定。
然而，文档修复通常更容易通过。因此，docrails 采用公开写入策略，以简化贡献者的工作流程。
所有提交都必须经过审核，因此 docrails 需要 Rails 提交者付出与处理拉取请求相同的努力，请大家大力感谢 Vijay Dev，他目前负责这项耗时的工作。
docrails 的目的是为贡献者提供一种快速便捷的方式来为 Rails 文档做出贡献。
docrails 是一个独立的分支，因为它具有不同的访问策略，但您正在编辑实际的 Ruby on Rails 文档。
每隔几天，一旦所有新提交都经过审核，docrails 就会合并到 master，master 也会合并到 docrails。此外，非常重要的编辑可能会根据合并者的判断被挑选到稳定分支。
您可以自由地向任何 RDoc、指南和 README 文件提交更改。
完全不允许修改代码。这是硬性规定。无论多么微不足道，即使是字符串字面量中一个字符的拼写错误也不行。
CHANGELOGs 也不能编辑。
不，Ruby on Rails 没有文档项目。将文档视为项目的一个独立方面，就像将测试视为项目的一个外部部分一样。
文档是 Ruby on Rails 开发的一个不可或缺的部分。贡献一个功能或 bug 修复意味着贡献其代码、测试覆盖率和文档。
不，docrails 仅用于快速文档修复。
拉取请求应该是完整的：代码、测试和文档。如果一个拉取请求在任何方面有所欠缺，通常不会被接受。
此外，更新文档不仅仅意味着您编辑您正在修改的代码旁边的 RDoc。通常，更改需要搜索整个项目树来查找与拉取请求相关的内容，以更新示例，修订受您的更改影响的解释，或编写新的文档。
花絮：运行 ack -a 可以将指南包含在搜索范围内。
Rails 的版本是一个完整的集合。文档本身是版本的一部分。当包含修复的分支被发布时，修复将在稳定 API 或 指南网站上在线。
合并到 master 的编辑始终在线上的边缘 API 和 边缘指南中，它们在每次推送到 master 后都会重新生成。因此，通过 docrails 完成的编辑将在下一次 docrails/master 交叉合并后在线上的边缘文档网站上显示。
绝对可以。特别是如果您对修复不确定。但如果您有信心，只需推送到 docrails 即可。
请不要在 docrails 中打开拉取请求。
请注意，docrails 没有 issues 标签。原因在于 docrails 不是一个项目，如上所述，它只是一种绕过拉取请求的方式。文档问题是 Ruby on Rails 的问题，与任何其他类型的问题一样，属于 Ruby on Rails 项目。
不，文档随每次推送到 master 一起提供。每个人都为 Rails 编写文档。
唯一的例外是指南作者。指南作者负责撰写关于某个主题的完整新指南，并且为了方便起见，他们可以提前将草稿推送到 docrails（只有在公共索引中的指南才被视为已发布）。
这适用于新指南。一旦发布，指南的维护就像其他一切一样在 master 中进行。