From e0fc81f4a9d9ff74c7368dfa95678c2c4941ff4e Mon Sep 17 00:00:00 2001
From: Ren Yamanashi <96362223+ren-yamanashi@users.noreply.github.com>
Date: Sat, 7 Dec 2024 15:11:48 +0900
Subject: [PATCH] docs: add versioningPolicy (#73)

* docs: add VERSIONING_POLICY.md

* docs: add introduction.md
---
 README.md                     |  4 ++++
 VERSIONING_POLICY.md          | 34 ++++++++++++++++++++++++++++++++++
 docs/.vitepress/config.mts    | 10 ++++++++++
 docs/introduction/index.md    | 22 ++++++++++++++++++++++
 docs/ja/introduction/index.md | 22 ++++++++++++++++++++++
 5 files changed, 92 insertions(+)
 create mode 100644 VERSIONING_POLICY.md
 create mode 100644 docs/introduction/index.md
 create mode 100644 docs/ja/introduction/index.md

diff --git a/README.md b/README.md
index e6e9280..eb1ce9c 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,10 @@ If you have any questions or suggestions, please open an [issue](https://github.
 
 Contributions are welcome! Please see [Contribution Guide](./CONTRIBUTING.md) for more details.
 
+## ⚓ Versioning Policy
+
+Please see [Versioning Policy](./VERSIONING_POLICY.md).
+
 ## ©️ License
 
 [MIT](http://opensource.org/licenses/MIT)
diff --git a/VERSIONING_POLICY.md b/VERSIONING_POLICY.md
new file mode 100644
index 0000000..f36a95e
--- /dev/null
+++ b/VERSIONING_POLICY.md
@@ -0,0 +1,34 @@
+## Semantic Versioning Policy
+
+eslint-cdk-plugin follows semantic versioning. To clarify when a minor or major version bump occurs, we've defined the following semantic versioning policy:
+
+### Patch Release (intended to not break your lint build)
+
+- A bug fix in a rule that results in fewer linting errors
+- A bug fix to the core functionality
+- Improvements to documentation
+- Non-user-facing changes such as refactoring code, adding/modifying tests, and increasing test coverage
+- Re-releasing after a failed release
+
+### Minor Release (might break your lint build)
+
+- A bug fix in a rule that results in more linting errors
+- A new rule is added (disabled by default)
+- A new option to an existing rule that does not result in more linting errors by default
+- An existing rule is deprecated
+
+### Major Release (likely to break your lint build)
+
+- `recommended` config is updated and may result in new linting errors
+- A new rule is added (enabled by default)
+- Removing deprecated rules or functionality
+- Changes that require a new minimum version of Node.js or ESLint
+
+### Version Pinning Recommendations
+
+We recommend using one of the following approaches in your `package.json`:
+
+- Use tilde (`~`) to allow only patch releases: `"eslint-cdk-plugin": "~1.1.0"`
+- Use caret (`^`) if you're comfortable with minor updates: `"eslint-cdk-plugin": "^1.1.0"`
+
+Note that minor updates may report more linting errors than the previous release, so using tilde is recommended for more stable builds.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index efd210c..22e2dff 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -74,6 +74,11 @@ export default defineConfig({
         ...defaultConfig.themeConfig,
         logo: "/img/logo.png",
         sidebar: [
+          {
+            text: "Introduction",
+            collapsed: true,
+            link: "/introduction/",
+          },
           {
             text: "Getting Started",
             collapsed: true,
@@ -152,6 +157,11 @@ export default defineConfig({
         ...defaultConfig.themeConfig,
         logo: "/img/logo.png",
         sidebar: [
+          {
+            text: "Introduction",
+            collapsed: true,
+            link: "/ja/introduction/",
+          },
           {
             text: "Getting Started",
             collapsed: true,
diff --git a/docs/introduction/index.md b/docs/introduction/index.md
new file mode 100644
index 0000000..74677de
--- /dev/null
+++ b/docs/introduction/index.md
@@ -0,0 +1,22 @@
+# Introduction
+
+ESLint plugin for [AWS CDK](https://aws.amazon.com/cdk/).
+
+This plugin allows us to check the AWS CDK code with ESLint.
+
+- Finds syntax errors.
+- Finds the violation for AWS CDK Best Practices.
+
+ESLint editor integrations are useful to check your code in real-time.
+
+## 🚥 Versioning policy
+
+Please see [Versioning Policy](https://github.com/ren-yamanashi/eslint-cdk-plugin/blob/main/VERSIONING_POLICY.md).
+
+## 📰 Changelog
+
+We are using [GitHub Releases](https://github.com/ren-yamanashi/eslint-cdk-plugin/releases).
+
+## 🔒 License
+
+See the [LICENSE](https://github.com/ren-yamanashi/eslint-cdk-plugin/blob/main/LICENSE) file for license rights and limitations (MIT).
diff --git a/docs/ja/introduction/index.md b/docs/ja/introduction/index.md
new file mode 100644
index 0000000..1e7ce34
--- /dev/null
+++ b/docs/ja/introduction/index.md
@@ -0,0 +1,22 @@
+# Introduction
+
+[AWS CDK](https://aws.amazon.com/cdk/) 用の ESLint プラグインです。
+
+このプラグインを使うことで、AWS CDK のコードを ESLint でチェックすることができます。
+
+- 構文エラーを検出します。
+- AWS CDK のベストプラクティス違反の発見。
+
+ESLint エディタとの統合は、リアルタイムにコードをチェックするのに便利です。
+
+## 🚥 Versioning policy
+
+[Versioning Policy](https://github.com/ren-yamanashi/eslint-cdk-plugin/blob/main/VERSIONING_POLICY.md) をご覧ください。
+
+## 📰 Changelog
+
+[GitHub Releases](https://github.com/ren-yamanashi/eslint-cdk-plugin/releases) を使用しています。
+
+## 🔒 License
+
+ライセンスの権利と制限（MIT）については、[LICENSE](https://github.com/ren-yamanashi/eslint-cdk-plugin/blob/main/LICENSE)ファイルを参照してください。