Skip to content

Commit fbd8fff

Browse files
committed
docs!: Add Versioning Policy
1 parent f90122d commit fbd8fff

File tree

2 files changed

+25
-3
lines changed

2 files changed

+25
-3
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@ See [here](https://eslint-plugin-vue-i18n.intlify.dev)
2323

2424
Details changes for each release are documented in the [CHANGELOG.md](https://github.com/intlify/eslint-plugin-vue-i18n/blob/master/CHANGELOG.md).
2525

26+
## 🚥 Versioning policy
27+
28+
This plugin follows [Semantic Versioning].
29+
However, please note that we do not follow [ESLint's Semantic Versioning Policy].
30+
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.
31+
32+
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.
33+
34+
[Semantic Versioning]: https://semver.org/
35+
[ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy
36+
2637
## ❗ Issues
2738

2839
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.

docs/started.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting Started
22

3-
## :cd: Installation
3+
## 💿 Installation
44

55
Use [npm](https://www.npmjs.com/) or a compatible tool.
66

@@ -15,7 +15,7 @@ npm install --save-dev eslint @intlify/eslint-plugin-vue-i18n
1515

1616
:::
1717

18-
## :rocket: Usage
18+
## 🚀 Usage
1919

2020
### Configuration `eslint.config.[c|m]js`
2121

@@ -227,7 +227,18 @@ You can install [eslint-plugin-jsonc](https://ota-meshi.github.io/eslint-plugin-
227227

228228
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.
229229

230-
## :question: FAQ
230+
## 🚥 Versioning policy
231+
232+
This plugin follows [Semantic Versioning].
233+
However, please note that we do not follow [ESLint's Semantic Versioning Policy].
234+
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.
235+
236+
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.
237+
238+
[Semantic Versioning]: https://semver.org/
239+
[ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy
240+
241+
## ❓ FAQ
231242

232243
### What is the "Use the latest vue-eslint-parser" error?
233244

0 commit comments

Comments
 (0)