This is the Inspire Ruby Style Guide
Add this line to your application's Gemfile:
gem 'rubocop-inspire', require: false
Add this to your project .rubocop.yml
file
inherit_gem:
rubocop-inspire: rubocop.yml
And then execute:
$ bundle install
You can continue to add application-specific rules/overrides in the
.rubocop.yml
file in the root of your application, including annotating
your todo list:
inherit_from: .rubocop_todo.yml
In your application, use the path
attribute to point to your local copy of the gem
# Use the relative path from your application, to the rubocop-inspire folder
gem 'rubocop-inspire', path: '../rubocop-inspire', require: false
If you have access to publish the gem on rubygems:
- Update the
version.rb
file as appropriate bundle
if any dependencies have changed- Commit all changes
- Update the
CHANGELOG.md
- Publish to rubygems:
rake build
cd pkg
gem push rubocop-inspire.<version_number>.gem
Bug reports and pull requests are welcome on GitHub at https://github.com/DWPHoldings/rubocop-inspire.
The gem is available as open source under the terms of the MIT License.