Include a note about running without type resolution by default

woltapp · Mar 27, 2023 · f4b19d9 · f4b19d9
1 parent 6bdc1e2
commit f4b19d9
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,8 @@ ArrowRuleSet:
     active: true
 ```
 
+Note that by default Detekt runs without type resolution enabled (just running `detekt` will not run the rules from this repo), see [Detekt documentation on that](https://detekt.dev/docs/gettingstarted/type-resolution/).
+
 ## Contribution guidelines
 - Read [Detekt documentation](https://detekt.dev/docs/introduction/extensions/) about extending it.
 - When adding a new rule, don't forget to include it RuleSetProvider (or create one if adding a new rule set).