Merge pull request #195 from Shopify/andyw8/clarify-rubocop-rbi-setup

Clarify RuboCop setup for RBI files
Shopify · Dec 19, 2023 · 5e5e119 · 5e5e119
2 parents a414cb7 + 6cbe174
commit 5e5e119
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -69,6 +69,14 @@ inherit_gem:
 
 This will turn off default cops for `**/*.rbi` files and enable the RBI specific cops.
 
+You'll also need to add an entry to the main `.rubocop.yml` so that RBI files are included, e.g.:
+
+```yaml
+AllCops:
+  Include:
+    - "sorbet/rbi/shims/**/*.rbi"
+```
+
 ## The Cops
 All cops are located under [`lib/rubocop/cop/sorbet`](lib/rubocop/cop/sorbet), and contain examples/documentation.