Switchcop

Ruby is the main language used in SwitchDreams, and to help enforce our style guide in our projects we created Switchcop as our main Rubocop configuration gem and to serve as the Style Guide itself. We intend to update this gem as our style guide gets better over time.

Add this line to your application's Gemfile:

gem "switchcop", require: false

Add switchcop's Rubocop configuration file to your .rubocop.yml:

inherit_gem:
  switchcop: rubocop.yml

For more information about inheriting configuration from a gem please check RuboCop's documentation.

After checking out the repo, run bin/setup to install dependencies. 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 the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/switchcop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

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

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