README.md in rubocop-bitcrowd-2.1.3 vs README.md in rubocop-bitcrowd-2.2.0

- old
+ new

@@ -1,25 +1,25 @@ -# Rubocop::Bitcrowd +# rubocop-bitcrowd 🚓 The bitcrowd rubocop.yml as a gem. ## Installation Add this lines to your application's Gemfile: ```ruby -gem 'rubocop' -gem 'rubocop-bitcrowd' +gem 'rubocop', require: false +gem 'rubocop-bitcrowd', require: false ``` And then execute: $ bundle ## Usage -To use the configuration in your project create a .rubocop.yml with: +To use the configuration in your project create a `.rubocop.yml` with: ```yml inherit_gem: rubocop-bitcrowd: .rubocop.yml @@ -28,22 +28,34 @@ merge: - Include - Exclude ``` -# Using rubocop-rspec +### Using other rubocop gems -There is also a config file for rubocop-rspec. To use it add rubocop-rspec to your Gemfile. +There are also config files for the other `rubocop` gems: +* [rubocop-rails](https://github.com/rubocop-hq/rubocop-rails) +* [rubocop-rspec](https://github.com/rubocop-hq/rubocop-rspec) +* [rubocop-performance](https://github.com/rubocop-hq/rubocop-performance) + +To use any of them, add the respective gem to your Gemfile: + ```ruby - gem 'rubocop-rspec' +gem 'rubocop-rails', require: false +gem 'rubocop-rspec', require: false +gem 'rubocop-performance', require: false ``` +Then include the bitcrowd config in your `.rubocop.yml`: + ```yml inherit_gem: rubocop-bitcrowd: - .rubocop.yml - .rubocop-rspec.yml + - .rubocop-rails.yml + - .rubocop-performance.yml # Note: skip this if you want to override the default AllCops:Include and AllCops:Exclude list inherit_mode: merge: - Include @@ -60,16 +72,16 @@ 2. Create a rubocop_todo.yml with: `rubocop --auto-gen-config` 3. Make sure you have a clean state in git, since the script will make commits for you (you may want to commit your rubocop_todo.yml) 4. Run the script (may take a while, when you want to continue working on your project meanwhile run this in a separate checkout): `rubocop-autofix` 5. Review all commits made by the script and run your tests. You can now drop certain commits of cops you don't want. Often it may make some sense to run the script again with changed settings, since rebasing 100+ commits is no fun. -# Development +## Development Any contributions are welcome. If you attempt to change the behavior of this gem it might be wise to open an issue first to discuss the change. Otherwise feel free to open a PR. Every PR should have a change in the [CHANGELOG](./CHANGELOG.md) file (within the [`master` section](./CHANGELOG.md#master)) briefly outlining the attempted changes. -## Release a new version +### Release a new version To release a new version, follow these steps: 1. update the [CHANGELOG](./CHANGELOG.md) to reflect the new release and prepare a new [`master` section](./CHANGELOG.md#master) 2. update the version in `rubocop-bitcrowd.gemspec` according to [semver](https://semver.org/)