贡献

问题

在 GitHub 问题跟踪器上报告问题并建议功能和改进。

如果你想提交问题（错误报告或功能请求），请提供我们在问题报告模板中列出的所有必要信息（在你创建新的 GitHub 问题时会自动加载）。

请不要在问题跟踪器上提出类似支持的问题（例如，“如何配置 RuboCop 来执行 X？” - 请使用支持渠道）。

任何形式的补丁都非常欢迎！GitHub 拉取请求更棒！:-)

在提交补丁或拉取请求之前，请确保所有测试都通过，并且你的补丁符合贡献指南。

一个方便的方法是使用 rake check_commit 来测试你最近提交中修改过的文件（使用 rspec 和 rubocop）。

另请参阅开发部分。

良好的文档与良好的代码一样重要。请帮助我们改进 RuboCop 的文档。

你还可以查看文档的 Cop 文档部分，并考虑添加或改进 Cop 描述。

手册是从 RuboCop 的 GitHub 仓库的 docs 文件夹中的 AsciiDoc 文件生成的，并发布到 https://rubocop-docs.ruby-lang.org.cn。 Antora 用于将手册转换为 HTML。文件系统布局在 https://docs.antora.org/antora/2.0/component-structure/ 中描述。

要对手册进行更改，只需更改 doc 下的文件即可。手册将定期手动重新生成。

此处的说明假设你已经安装了（正确版本的）node.js。

安装 Antora 非常简单

$ npm i -g @antora/[email protected] @antora/[email protected]

如果你遇到任何问题，请查看详细的安装说明。

你可以从 docs.rubocop.org 仓库本地构建文档。

$ cd docs.rubocop.org
$ antora --pull antora-playbook.yml

完成初始设置后，你可以使用 deploy 脚本将更改推送到网站

./deploy

你需要对仓库有提交权限才能使用此功能。

要查看生成的网站，你只需在你的浏览器中打开 `docs/index.html`。

如果你想更改手册的页面结构，你需要编辑 nav.adoc。

虽然 RuboCop 是自由软件，并且将永远是，但该项目将从一些资金中受益匪浅。筹集每月几千美元的预算将使我们能够支付人员来处理某些复杂的功能，资助其他与开发相关的项目（例如硬件、会议旅行）等等。筹集每月超过 5000 美元的预算将使有人能够全职参与该项目，这将显著加快开发速度。

我们欢迎个人和企业赞助商！我们还提供各种资金渠道来满足您的偏好（尽管目前 Open Collective 是我们首选的资金平台）。

如果您在一家大量使用 RuboCop 的公司工作，我们希望您建议您的公司成为 RuboCop 的赞助商。

您可以通过 GitHub Sponsors、Patreon、PayPal 和 Open Collective 支持 RuboCop 的开发。