README.markdown

FutureLearn Rubocop Configuration

This gem provides baseline rubocop config governing ruby code formatting and general linting in FutureLearn software projects, following our company style guide.

While it can be overridden by individual projects including it, we should aim to adhere to this unless strictly necessary.

Installation

Add this line to your application's Gemfile and run bundle install.

gem 'rubocop-futurelearn', require: false

Then in your project's rubocop config:

# .rubocop.yml
inherit_gem:
  rubocop-futurelearn:
    - config/default.yml
    # Optionally
    - config/rspec.yml

inherit_mode:
  merge:
    - Exclude