Skip to content

Commit

Permalink
docs!: Add Versioning Policy (#583)
Browse files Browse the repository at this point in the history
* docs!: Add Versioning Policy

* Create dirty-meals-run.md
  • Loading branch information
ota-meshi authored Dec 27, 2024
1 parent 6e51a48 commit 9a5601e
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .changeset/dirty-meals-run.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@intlify/eslint-plugin-vue-i18n": major
---

docs!: Add Versioning Policy
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 14 additions & 3 deletions docs/started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

## :cd: Installation
## 💿 Installation

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

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

:::

## :rocket: Usage
## 🚀 Usage

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

Expand Down Expand Up @@ -224,7 +224,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?

Expand Down

0 comments on commit 9a5601e

Please sign in to comment.