From 5800d921144ec330b6ee7cd03364434007331354 Mon Sep 17 00:00:00 2001 From: Brandon Mills Date: Fri, 29 Jan 2021 22:40:44 -0500 Subject: [PATCH] Docs: Clarify stylistic rule update policy (#14052) * Docs: Clarify stylistic rule update policy Refs eslint/tsc-meetings#237. * Docs: Add missing period in stylistic rule policy Co-authored-by: Milos Djermanovic * Docs: Add stylistic rule policy to README ToC Co-authored-by: Milos Djermanovic --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index aab94acb7fe..624ad9e3adb 100644 --- a/README.md +++ b/README.md @@ -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) ## Installation and Usage @@ -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. +## 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. + ## 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)