If you want to file a bug, please provide all the necessary info listed in our issue reporting template (it's loaded automatically when you create a new GitHub issue).
Patches in any form are always welcome! GitHub pull requests are even better! :-)
Before submitting a patch or a pull request make sure all tests are passing and that your patch is in line with the contribution guidelines.
See also. development.md
Good documentation is just as important as good code.
Consider improving and extending the this manual and the community wiki.
Working on the Manual
To make changes to the manual you simply have to change the files under
manual. The manual will be regenerated automatically when changes to those files
are merged in
master (or the latest stable branch).
You can install
MkDocs locally and use the command
mkdocs serve to see the
result of changes you make to the manual locally:
$ cd path/to/rubocop/repo $ mkdocs serve
If you want to make changes to the manual's page structure you'll have to edit mkdocs.yml.
While RuboCop is free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of a couple of thousand dollars would make it possible to pay people to work on certain complex features, fund other development related stuff (e.g. hardware, conference trips) and so on. Raising a monthly budget of over $5000 would open the possibility of someone working full-time on the project which would speed up the pace of development significantly.
We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences (although currently Open Collective is our preferred funding platform).
If you're working in a company that's making significant use of RuboCop we'd appreciate it if you suggest to your company to become a RuboCop sponsor.