Skip to content

Commit 523eb8b

Browse files
Change Versioning Policy (#2630)
Co-authored-by: Flo Edelmann <git@flo-edelmann.de>
1 parent 5d1d402 commit 523eb8b

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,14 @@ Please refer to the [official website](https://eslint.vuejs.org).
1313

1414
## :anchor: Versioning Policy
1515

16-
This plugin follows [Semantic Versioning](https://semver.org) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
16+
This plugin follows [Semantic Versioning].
17+
However, please note that we do not follow [ESLint's Semantic Versioning Policy].
18+
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.
19+
20+
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.
21+
22+
[Semantic Versioning]: https://semver.org/
23+
[ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy
1724

1825
## :newspaper: Releases
1926

docs/index.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,14 @@ ESLint editor integrations are useful to check your code in real-time.
1616

1717
## :traffic_light: Versioning policy
1818

19-
This plugin is following [Semantic Versioning](https://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).
19+
This plugin follows [Semantic Versioning].
20+
However, please note that we do not follow [ESLint's Semantic Versioning Policy].
21+
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.
22+
23+
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.
24+
25+
[Semantic Versioning]: https://semver.org/
26+
[ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy
2027

2128
## :newspaper: Changelog
2229

0 commit comments

Comments
 (0)