Skip to content

Commit 2eddce7

Browse files
authored
Merge pull request #119 from github/rubocop-default-enablement
config/default: Unset `DisabledByDefault: true`
2 parents bbe922b + 6bbad25 commit 2eddce7

File tree

4 files changed

+1735
-86
lines changed

4 files changed

+1735
-86
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# rubocop-github
2+
3+
## Unreleased
4+
5+
- Unset `DisabledByDefault: true` in `config/default.yml`. Prevents confusing behaviour where users of the gem didn't realise that RuboCop's default cops weren't being applied (including potentially custom cops in their projects). We've explicitly set `Enabled: false` for all the cops that were previously default disabled. This has the effect that consumers of this gem won't be surprised by new linting violations when they use this new version in their projects. (https://github.com/github/rubocop-github/pull/119)

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ Alternatively, only require the additional custom cops in your `.rubocop.yml` wi
3333

3434
💭 Looking for `config/accessibility.yml` and the `GitHub/Accessibility` configs? They have been moved to [a new gem](https://github.com/github/rubocop-rails-accessibility).
3535

36+
For more granular control over which of RuboCop's rules are enabled for your project, both from this gem and your own configs, consider using the `DisabledByDefault: true` option under `AllCops` in your project's `.rubocop.yml` file. This will disable all cops by default, and you can then explicitly enable the ones you want by setting `Enabled: true`. See [the RuboCop docs](https://docs.rubocop.org/rubocop/configuration.html#enabled) for more information.
37+
3638
### Legacy usage
3739

3840
If you are using a rubocop version < 1.0.0, you can use rubocop-github version

0 commit comments

Comments
 (0)