From fbd8fff1abbcac5181a0cb4a8ae3707e508c2992 Mon Sep 17 00:00:00 2001 From: yosuke ota Date: Mon, 9 Dec 2024 09:31:56 +0900 Subject: [PATCH 1/2] docs!: Add Versioning Policy --- README.md | 11 +++++++++++ docs/started.md | 17 ++++++++++++++--- 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 66c485f4..f58da71f 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,17 @@ See [here](https://eslint-plugin-vue-i18n.intlify.dev) Details changes for each release are documented in the [CHANGELOG.md](https://github.com/intlify/eslint-plugin-vue-i18n/blob/master/CHANGELOG.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 Vue I18n, 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 (`~`)](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 + ## ❗ Issues Please make sure to read the [Issue Reporting Checklist](https://github.com/intlify/eslint-plugin-vue-i18n/blob/master/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately. diff --git a/docs/started.md b/docs/started.md index e9195d10..222d1c19 100644 --- a/docs/started.md +++ b/docs/started.md @@ -1,6 +1,6 @@ # Getting Started -## :cd: Installation +## 💿 Installation Use [npm](https://www.npmjs.com/) or a compatible tool. @@ -15,7 +15,7 @@ npm install --save-dev eslint @intlify/eslint-plugin-vue-i18n ::: -## :rocket: Usage +## 🚀 Usage ### Configuration `eslint.config.[c|m]js` @@ -227,7 +227,18 @@ You can install [eslint-plugin-jsonc](https://ota-meshi.github.io/eslint-plugin- You can also use [jsonc/vue-custom-block/no-parsing-error](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/vue-custom-block/no-parsing-error.html) and [yml/vue-custom-block/no-parsing-error](https://ota-meshi.github.io/eslint-plugin-yml/rules/vue-custom-block/no-parsing-error.html) rules to find JSON and YAML parsing errors. -## :question: FAQ +## 🚥 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 Vue I18n, 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 (`~`)](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 + +## ❓ FAQ ### What is the "Use the latest vue-eslint-parser" error? From 6c8133561b489e8b052da275883418abbd1e30f2 Mon Sep 17 00:00:00 2001 From: Yosuke Ota Date: Mon, 9 Dec 2024 09:32:18 +0900 Subject: [PATCH 2/2] Create dirty-meals-run.md --- .changeset/dirty-meals-run.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/dirty-meals-run.md diff --git a/.changeset/dirty-meals-run.md b/.changeset/dirty-meals-run.md new file mode 100644 index 00000000..1aaabb52 --- /dev/null +++ b/.changeset/dirty-meals-run.md @@ -0,0 +1,5 @@ +--- +"@intlify/eslint-plugin-vue-i18n": major +--- + +docs!: Add Versioning Policy