Skip to content

Commit

Permalink
added reasons why a new rule should be opt in
Browse files Browse the repository at this point in the history
this is a modification of realm#850
all credit goes to @marcelofabri
  • Loading branch information
masters3d authored Oct 24, 2016
1 parent c16efa1 commit 1f062c4
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ and are subject to change.
See the [Source/SwiftLintFramework/Rules](Source/SwiftLintFramework/Rules)
directory to see the currently implemented rules.

opt_in_rules are disabled by default (you have to explicitly add them on your configuration file).

Guidelines on when to implement a rule as opt-in:
* A rule that can have many false positives (empty_count)
* A rule that is too slow
* A rule that is not general consensus or only useful in some cases (force_unwrapping, missing_docs)


### Disable a rule in code

Rules can be disabled with a comment inside a source file with the following
Expand Down

0 comments on commit 1f062c4

Please sign in to comment.