From a5d700b98f4ecbf83a1559c4f16051de42a1af6e Mon Sep 17 00:00:00 2001 From: Yuichiro Yamashita Date: Mon, 16 Dec 2024 13:48:46 +0900 Subject: [PATCH] chore: update README regarding versioning policy (#964) --- README.md | 9 +++++++-- docs/README.md | 2 -- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a959eda16..2601875d0 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,6 @@ You can check on the [Online DEMO](https://eslint-online-playground.netlify.app/ > For example, > and -**_We are working on experimental support for Svelte v5, but may break with new versions of Svelte v5._** - [![NPM license](https://img.shields.io/npm/l/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte) [![NPM version](https://img.shields.io/npm/v/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte) [![NPM downloads](https://img.shields.io/badge/dynamic/json.svg?label=downloads&colorB=green&suffix=/day&query=$.downloads&uri=https://api.npmjs.org//downloads/point/last-day/eslint-plugin-svelte&maxAge=3600)](http://www.npmtrends.com/eslint-plugin-svelte) @@ -46,6 +44,13 @@ We are working on support for Svelte v5, but it is still an experimental feature +## Versioning policy + +This plugin follows [Semantic Versioning](https://semver.org/). +However, unlike [ESLint’s Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy), this plugin adds new rules to its configs even in minor releases. For example, if you are using the recommended config, a minor update may add new rules, which could cause new lint errors in your project. +While [ESLint’s Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy) only adds new rules to configs in major releases, most users (myself included) don’t regularly monitor new rules. This makes it challenging to manually add them to projects whenever they are introduced. +By adding new rules to configs in minor releases, this plugin ensures users can adopt them more easily. If any new rules cause issues, you can simply disable them. I believe this approach helps maintain and improve code quality with minimal effort. + ## Migration Guide To migrate from `eslint-plugin-svelte` v1, or [`@ota-meshi/eslint-plugin-svelte`](https://www.npmjs.com/package/@ota-meshi/eslint-plugin-svelte), please refer to the [migration guide](https://sveltejs.github.io/eslint-plugin-svelte/migration/). diff --git a/docs/README.md b/docs/README.md index 38f818750..e7bea45ea 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,8 +14,6 @@ You can check on the [Online DEMO](https://eslint-online-playground.netlify.app/ > For example, > and -**_We are working on experimental support for Svelte v5, but may break with new versions of Svelte v5._** - [![NPM license](https://img.shields.io/npm/l/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte) [![NPM version](https://img.shields.io/npm/v/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte) [![NPM downloads](https://img.shields.io/badge/dynamic/json.svg?label=downloads&colorB=green&suffix=/day&query=$.downloads&uri=https://api.npmjs.org//downloads/point/last-day/eslint-plugin-svelte&maxAge=3600)](http://www.npmtrends.com/eslint-plugin-svelte)