README.md

groundwork-style

Shared style configs for rubocop.

Installation

Add this to your application's Gemfile:

group :development, :test do
  gem 'groundwork-style', github: 'buildgroundwork/groundwork-style', require: false
end

Usage

Create a .rubocop.yml with the following directives (or pick and choose):

inherit_gem:
  groundwork-style:
    - rubocop.yml
    - rubocop_performance.yml
    - rubocop_rake.yml
    - rubocop_rails.yml
    - rubocop_rspec.yml

You can include, exclude, or modify cop configuration in your .rubocop.yml file.

You do not need to include rubocop directly in your application's dependencies (unless you're using an unpublished version of rubocop).

This will include the necessary rubocop-* gems.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Groundwork::Style project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.