From 0f906400353ab1a53ffb57b8a089fcb21b7dd101 Mon Sep 17 00:00:00 2001 From: "Nicholas C. Zakas" Date: Thu, 13 Aug 2020 13:35:35 -0700 Subject: [PATCH 1/2] Docs: Update semantic versioning policy --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7a9d1099068..9c9f79f68c3 100644 --- a/README.md +++ b/README.md @@ -149,27 +149,32 @@ ESLint takes security seriously. We work hard to ensure that ESLint is safe for ESLint follows [semantic versioning](https://semver.org). However, due to the nature of ESLint as a code quality tool, it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, we've defined the following semantic versioning policy for ESLint: * Patch release (intended to not break your lint build) - * A bug fix in a rule that results in ESLint reporting fewer errors. + * A bug fix in a rule that results in ESLint reporting fewer linting errors. * A bug fix to the CLI or core (including formatters). * Improvements to documentation. * Non-user-facing changes such as refactoring code, adding, deleting, or modifying tests, and increasing test coverage. * Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone). * Minor release (might break your lint build) - * A bug fix in a rule that results in ESLint reporting more errors. + * A bug fix in a rule that results in ESLint reporting more linting errors. * A new rule is created. - * A new option to an existing rule that does not result in ESLint reporting more errors by default. + * A new option to an existing rule that does not result in ESLint reporting more linting errors by default. * An existing rule is deprecated. * A new CLI capability is created. * New capabilities to the public API are added (new classes, new methods, new arguments to existing methods, etc.). * A new formatter is created. - * `eslint:recommended` is updated and will result in strictly fewer errors (e.g., rule removals). + * `eslint:recommended` is updated and will result in strictly fewer linting errors (e.g., rule removals). * Major release (likely to break your lint build) - * `eslint:recommended` is updated and may result in new errors (e.g., rule additions, most rule option updates). - * A new option to an existing rule that results in ESLint reporting more errors by default. + * `eslint:recommended` is updated and may result in new linting errors (e.g., rule additions, most rule option updates). + * A new option to an existing rule that results in ESLint reporting more linting errors by default. * An existing formatter is removed. - * Part of the public API is removed or changed in an incompatible way. - -According to our policy, any minor update may report more 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. + * Part of the public API is removed or changed in an incompatible way. The public API includes: + * Rule schemas + * Configuration schema + * Command-line options + * Node.js API + * Rule, formatter, parser, plugin formats + +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. ## License From f56da4bfb49ca855f1eaf0a76610a5e8b289f7f6 Mon Sep 17 00:00:00 2001 From: "Nicholas C. Zakas" Date: Fri, 14 Aug 2020 10:14:35 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: Brandon Mills --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c9f79f68c3..366f88cffd3 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ ESLint follows [semantic versioning](https://semver.org). However, due to the na * Configuration schema * Command-line options * Node.js API - * Rule, formatter, parser, plugin formats + * Rule, formatter, parser, plugin APIs 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.