Skip to content

Commit 68de222

Browse files
committed
feat! clarification Versioning policy
1 parent 054461d commit 68de222

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,17 @@ These rules extend the rules provided by ESLint itself to work well in Astro com
502502
<!--RULES_TABLE_END-->
503503
<!--RULES_SECTION_END-->
504504

505+
## 🚥 Versioning policy
506+
507+
This plugin follows [Semantic Versioning].
508+
However, please note that we do not follow [ESLint's Semantic Versioning Policy].
509+
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.
510+
511+
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.
512+
513+
[Semantic Versioning]: https://semver.org/
514+
[ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy
515+
505516
<!--DOCS_IGNORE_START-->
506517

507518
## 🍻 Contributing

docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,17 @@ See [User Guide](./user-guide.md).
4747

4848
See [Available Rules](./rules.md).
4949

50+
## 🚥 Versioning policy
51+
52+
This plugin follows [Semantic Versioning].
53+
However, please note that we do not follow [ESLint's Semantic Versioning Policy].
54+
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.
55+
56+
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.
57+
58+
[Semantic Versioning]: https://semver.org/
59+
[ESLint's Semantic Versioning Policy]: https://github.com/eslint/eslint#semantic-versioning-policy
60+
5061
## ❤️ Supporting
5162

5263
If you are willing to see that this package continues to be maintained, please consider sponsoring me.

0 commit comments

Comments
 (0)