Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Docs: Update new rules policies (#13343)
* Docs: Update new rules policies

* Update new rule issue template
  • Loading branch information
nzakas committed May 22, 2020
1 parent 3a5fbb3 commit 611c676
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE/NEW_RULE.md
Expand Up @@ -24,11 +24,15 @@ assignees: ''

**Please describe what the rule should do:**


**What new ECMAScript feature does this rule relate to?**

<!-- New rules must be related to ECMAScript features added within the last 12 months -->

**What category of rule is this? (place an "X" next to just one item)**

[ ] Warns about a potential error (problem)
[ ] Suggests an alternate way of doing something (suggestion)
[ ] Enforces code style (layout)
[ ] Other (please specify:)

**Provide 2-3 code examples that this rule will warn about:**
Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide/contributing/new-rules.md
Expand Up @@ -2,7 +2,7 @@

ESLint is all about rules. For most of the project's lifetime, we've had over 200 rules, and that list continues to grow. However, we can't just accept any proposed rule because all rules need to work cohesively together. As such, we have some guidelines around which rules can be part of the ESLint core and which are better off as custom rules and plugins.

**Note:** As of 2016, we accept only rules that are deemed extremely important for inclusion. We prefer that new rules be implemented in plugins.
**Note:** As of 2020, we only accept rules related to new ECMAScript features. We prefer that new rules be implemented in plugins.

## Core Rule Guidelines

Expand All @@ -29,7 +29,7 @@ In order for a rule to be accepted in the ESLint core, it must:

1. Fulfill all the criteria listed in the "Core Rule Guidelines" section
1. Have an ESLint team member champion inclusion of the rule
1. Be very important for ESLint users because it either catches a serious problem or allows styling of code in accordance with a popular style guide
1. Be related to an ECMAScript feature that has reached stage 4 in the preceding 12 months

Keep in mind that we have over 200 rules, and that is daunting both for end users and the ESLint team (who has to maintain them). As such, any new rules must be deemed of high importance to be considered for inclusion in ESLint.

Expand Down

0 comments on commit 611c676

Please sign in to comment.