From dc8f178b2408fd481eefb9bbd24c4ef4a0a7675e Mon Sep 17 00:00:00 2001 From: yosuke ota Date: Sat, 30 Nov 2024 15:34:37 +0900 Subject: [PATCH 1/2] Change Versioning Policy --- README.md | 9 ++++++++- docs/index.md | 9 ++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cacd80209..67ff10d48 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,14 @@ Please refer to the [official website](https://eslint.vuejs.org). ## :anchor: Versioning Policy -This plugin follows [Semantic Versioning](https://semver.org) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy). +This plugin follows [Semantic Versioning]. +However, please note that we do not follow [ESLint's Semantic Versioning Policy]. +In minor version releases, this plugin may change the sharable config provided by the plugin or the default behavior of the plugin's rules in order to add features to the plugin. Because we want to add many features to the plugin soon, so that users can easily take advantage of new features in Vue and Nuxt. + +According to our policy, any minor update may report more linting errors than the previous release. As such, we recommend using the tilde (`~`) in `package.json` to guarantee the results of your builds. + +[Semantic Versioning]: https://semver.org/ +[ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy ## :newspaper: Releases diff --git a/docs/index.md b/docs/index.md index 3fd2b6d66..77c1d4854 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,7 +16,14 @@ ESLint editor integrations are useful to check your code in real-time. ## :traffic_light: Versioning policy -This plugin is following [Semantic Versioning](https://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy). +This plugin follows [Semantic Versioning]. +However, please note that we do not follow [ESLint's Semantic Versioning Policy]. +In minor version releases, this plugin may change the sharable config provided by the plugin or the default behavior of the plugin's rules in order to add features to the plugin. Because we want to add many features to the plugin soon, so that users can easily take advantage of new features in Vue and Nuxt. + +According to our policy, any minor update may report more linting errors than the previous release. As such, we recommend using the tilde (`~`) in `package.json` to guarantee the results of your builds. + +[Semantic Versioning]: https://semver.org/ +[ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy ## :newspaper: Changelog From 0692875af2f644a97b58fe1143a372644ab61831 Mon Sep 17 00:00:00 2001 From: Yosuke Ota Date: Mon, 2 Dec 2024 06:45:16 +0900 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Flo Edelmann --- README.md | 4 ++-- docs/index.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 67ff10d48..95e0c08be 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,9 @@ Please refer to the [official website](https://eslint.vuejs.org). This plugin follows [Semantic Versioning]. However, please note that we do not follow [ESLint's Semantic Versioning Policy]. -In minor version releases, this plugin may change the sharable config provided by the plugin or the default behavior of the plugin's rules in order to add features to the plugin. Because we want to add many features to the plugin soon, so that users can easily take advantage of new features in Vue and Nuxt. +In minor version releases, this plugin may change the sharable configs provided by the plugin or the default behavior of the plugin's rules in order to add features to the plugin. Because we want to add many features to the plugin soon, so that users can easily take advantage of new features in Vue and Nuxt. -According to our policy, any minor update may report more linting errors than the previous release. As such, we recommend using the tilde (`~`) in `package.json` to guarantee the results of your builds. +According to our policy, any minor update may report more linting errors than the previous release. As such, we recommend using the [tilde (`~`)](https://semver.npmjs.com/#syntax-examples) in `package.json` to guarantee the results of your builds. [Semantic Versioning]: https://semver.org/ [ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy diff --git a/docs/index.md b/docs/index.md index 77c1d4854..9f6ce3192 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,9 +18,9 @@ ESLint editor integrations are useful to check your code in real-time. This plugin follows [Semantic Versioning]. However, please note that we do not follow [ESLint's Semantic Versioning Policy]. -In minor version releases, this plugin may change the sharable config provided by the plugin or the default behavior of the plugin's rules in order to add features to the plugin. Because we want to add many features to the plugin soon, so that users can easily take advantage of new features in Vue and Nuxt. +In minor version releases, this plugin may change the sharable configs provided by the plugin or the default behavior of the plugin's rules in order to add features to the plugin. Because we want to add many features to the plugin soon, so that users can easily take advantage of new features in Vue and Nuxt. -According to our policy, any minor update may report more linting errors than the previous release. As such, we recommend using the tilde (`~`) in `package.json` to guarantee the results of your builds. +According to our policy, any minor update may report more linting errors than the previous release. As such, we recommend using the [tilde (`~`)](https://semver.npmjs.com/#syntax-examples) in `package.json` to guarantee the results of your builds. [Semantic Versioning]: https://semver.org/ [ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy