https://github.com/aergonaut/rubocop-inclusivity
A RuboCop extension to promote inclusive language in Ruby projects.
https://github.com/aergonaut/rubocop-inclusivity
rubocop
Last synced: about 7 hours ago
JSON representation
A RuboCop extension to promote inclusive language in Ruby projects.
- Host: GitHub
- URL: https://github.com/aergonaut/rubocop-inclusivity
- Owner: aergonaut
- License: mit
- Created: 2020-04-05T04:32:19.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-03-14T19:49:49.000Z (about 3 years ago)
- Last Synced: 2024-05-21T02:19:27.661Z (11 months ago)
- Topics: rubocop
- Language: Ruby
- Homepage:
- Size: 51.8 KB
- Stars: 2
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# `rubocop-inclusivity`
**rubocop-inclusivity** is a RuboCop extension to promote inclusive language in
Ruby projects.
## Installation
Add this line to your application's Gemfile:
```ruby
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`](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:
```yaml
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](https://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](https://github.com/aergonaut/rubocop-inclusivity/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 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](https://github.com/[USERNAME]/rubocop-inclusivity/blob/master/CODE_OF_CONDUCT.md).