From 68de2226ebcad73ed63a5393c9119f9376ade5c5 Mon Sep 17 00:00:00 2001 From: yosuke ota Date: Mon, 31 Mar 2025 10:08:16 +0900 Subject: [PATCH 1/2] feat! clarification Versioning policy --- README.md | 11 +++++++++++ docs/README.md | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/README.md b/README.md index bd7d22e1..a7b0dba6 100644 --- a/README.md +++ b/README.md @@ -502,6 +502,17 @@ These rules extend the rules provided by ESLint itself to work well in Astro com +## 🚥 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 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 Astro. + +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 + ## 🍻 Contributing diff --git a/docs/README.md b/docs/README.md index ab30df1a..1971d1bf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -47,6 +47,17 @@ See [User Guide](./user-guide.md). See [Available Rules](./rules.md). +## 🚥 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 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 Astro. + +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 + ## ❤️ Supporting If you are willing to see that this package continues to be maintained, please consider sponsoring me. From 5b2d42c4bbf6c57453a3015f4079c9e92caa9055 Mon Sep 17 00:00:00 2001 From: Yosuke Ota Date: Mon, 31 Mar 2025 10:09:01 +0900 Subject: [PATCH 2/2] Create spicy-hounds-yawn.md --- .changeset/spicy-hounds-yawn.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/spicy-hounds-yawn.md diff --git a/.changeset/spicy-hounds-yawn.md b/.changeset/spicy-hounds-yawn.md new file mode 100644 index 00000000..3e465c83 --- /dev/null +++ b/.changeset/spicy-hounds-yawn.md @@ -0,0 +1,5 @@ +--- +"eslint-plugin-astro": minor +--- + +feat! clarification Versioning policy