Skip to content

Commit

Permalink
Docs: Clarify stylistic rule update policy (#14052)
Browse files Browse the repository at this point in the history
* Docs: Clarify stylistic rule update policy

Refs eslint/tsc-meetings#237.

* Docs: Add missing period in stylistic rule policy

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* Docs: Add stylistic rule policy to README ToC

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
  • Loading branch information
btmills and mdjermanovic committed Jan 30, 2021
1 parent 0ccf6d2 commit 5800d92
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Expand Up @@ -35,10 +35,11 @@ ESLint is a tool for identifying and reporting on patterns found in ECMAScript/J
6. [Releases](#releases)
7. [Security Policy](#security-policy)
8. [Semantic Versioning Policy](#semantic-versioning-policy)
9. [License](#license)
10. [Team](#team)
11. [Sponsors](#sponsors)
12. [Technology Sponsors](#technology-sponsors)
9. [Stylistic Rule Updates](#stylistic-rule-updates)
10. [License](#license)
11. [Team](#team)
12. [Sponsors](#sponsors)
13. [Technology Sponsors](#technology-sponsors)

## <a name="installation-and-usage"></a>Installation and Usage

Expand Down Expand Up @@ -187,6 +188,15 @@ ESLint follows [semantic versioning](https://semver.org). However, due to the na

According to our policy, any minor update may report more linting errors than the previous release (ex: from a bug fix). As such, we recommend using the tilde (`~`) in `package.json` e.g. `"eslint": "~3.1.0"` to guarantee the results of your builds.

## <a name="stylistic-rule-updates"></a>Stylistic Rule Updates

Stylistic rules are frozen according to [our policy](https://eslint.org/blog/2020/05/changes-to-rules-policies) on how we evaluate new rules and rule changes.
This means:

* **Bug fixes**: We will still fix bugs in stylistic rules.
* **New ECMAScript features**: We will also make sure stylistic rules are compatible with new ECMAScript features.
* **New options**: We will **not** add any new options to stylistic rules unless an option is the only way to fix a bug or support a newly-added ECMAScript feature.

## <a name="license"></a>License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint?ref=badge_large)
Expand Down

0 comments on commit 5800d92

Please sign in to comment.