Link to opt-in guidelines from issue template

yeradis · Aug 21, 2017 · dc0555a · dc0555a
1 parent 43ade3f
commit dc0555a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -15,6 +15,8 @@ this issue as `rule-request` and describe:
 2. Provide several examples of what _would_ and _wouldn't_ trigger violations.
 3. Should the rule be configurable, if so what parameters should be configurable?
 4. Should the rule be opt-in or enabled by default? Why?
+   See [README.md](../README.md#opt-in-rules) for guidelines on when to mark a
+   rule as opt-in.
 
 ### Bug Report
 

diff --git a/README.md b/README.md
@@ -217,7 +217,7 @@ directory to see their implementation.
 `opt_in_rules` are disabled by default (i.e., you have to explicitly enable them
 in your configuration file).
 
-Guidelines on when to implement a rule as opt-in:
+Guidelines on when to mark a rule as opt-in:
 
 * A rule that can have many false positives (e.g. `empty_count`)
 * A rule that is too slow