/oct-rubocop

O.C. Tanner's rubocop style guide rules.

Primary LanguageRuby

Oct::Rubocop

These gem contains the rubocop style guide for O.C. Tanner.

Installation

Add this line to your application's Gemfile:

gem 'oct-rubocop', git: 'https://github.com/octanner/oct-rubocop.git'

And then execute:

$ bundle

Or install it yourself as:

$ gem install oct-rubocop

Usage

See Inheriting-configuration-from-a-dependency-gem

Add this to the top of your .rubocop.yml

inherit_gem:
  oct-rubocop: oct_rubocop.yml

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/oct-rubocop.