rubocop-inclusivity

rubocop-inclusivity is a RuboCop extension to promote inclusive language in Ruby projects.

Installation

Add this line to your application's Gemfile:

gem 'rubocop-inclusivity', require: false

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rubocop-inclusivity

The Cops

All cops are located under lib/rubocop/cop/inclusivity, and contains examples/documentation.

In your .rubocop.yml, you may treat the Inclusivity cops just like any other cop. For example:

Inclusivity/Race:
  Exclude:
    - lib/example.rb

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/aergonaut/rubocop-inclusivity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

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