Contents

# Optimum Energy Rubocop

This is the [shared](https://rubocop.readthedocs.io/en/latest/configuration/) team Rubocop
configuration for [Optimum Energy](http://optimumenergyco.com/).

## Installation

First, add `optimum-energy-rubocop` to your `Gemfile` and run `bundle install`. We recommend not
locking in the version of the gem because we regularly update this repo as we come across new rules.

```
gem 'optimum-energy-rubocop'
```

Create a `.rubocop.yml` file and add this configuration.

```
require:
  - optimum-energy-rubocop

inherit_from:
  - optimum_energy_rubocop.yml
```

## Updating This Gem

After making changes to the rules in the [optimum_energy_rubocop.yml](optimum_energy_rubocop.yml)
file, be sure that the version is bumped in both the [VERSION.txt](VERSION.txt) and
[Gemfile.lock](Gemfile.lock) files. If the version is not changed, repos consuming this gem will not
get the updates.

## Running Rubocop

To run the cops locally for this repo, run `bundle exec rubocop` from the command line.

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
optimum-energy-rubocop-0.7.8	README.md
optimum-energy-rubocop-0.7.7	README.md
optimum-energy-rubocop-0.7.6	README.md
optimum-energy-rubocop-0.7.5	README.md
optimum-energy-rubocop-0.7.4	README.md