RuboCop GitHub

This repository provides recommended RuboCop configuration and additional Cops for use on GitHub open source and internal Ruby projects.

Usage

Gemfile

gem "rubocop-github"
gem "rubocop-performance", require: false
gem "rubocop-rails", require: false

.rubocop.yml

inherit_gem:
  rubocop-github:
    - config/default.yml
    - config/rails.yml
    - config/accessibility.yml

Legacy usage

If you are using a rubocop version < 1.0.0, you can use rubocop-github version 0.16.2 (see the README from that version for more details).

Testing

bundle install bundle exec rake test

The Cops

All cops are located under lib/rubocop/cop/github and lib/rubocop/cop/github/accessibility, and contain examples/documentation.