eslint-cdk-plugin 1.0.0 → 1.0.1

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img width="160px" height="160px" src="./assets/logo.png" alt="ESLint plugin for AWS CDK logo">
+  <img width="160px" height="160px" src="https://raw.githubusercontent.com/ren-yamanashi/eslint-cdk-plugin/main/assets/logo.png" alt="ESLint plugin for AWS CDK logo">
 </p>
 
 <h1 align="center">eslint-cdk-plugin</h1>
@@ -71,11 +71,11 @@ If you have any questions or suggestions, please open an [issue](https://github.
 
 ## 💪 Contribution
 
-Contributions are welcome! Please see [Contribution Guide](./CONTRIBUTING.md) for more details.
+Contributions are welcome! Please see [Contribution Guide](https://github.com/ren-yamanashi/eslint-cdk-plugin/blob/main/CONTRIBUTING.md) for more details.
 
 ## ⚓ Versioning Policy
 
-Please see [Versioning Policy](./VERSIONING_POLICY.md).
+Please see [Versioning Policy](https://github.com/ren-yamanashi/eslint-cdk-plugin/blob/main/VERSIONING_POLICY.md).
 
 ## ©️ License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-cdk-plugin",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "eslint plugin for AWS CDK projects",
   "main": "dist/index.mjs",
   "type": "module",
@@ -36,10 +36,7 @@
   "files": [
     "dist",
     "README.md",
-    "LICENSE",
-    "CONTRIBUTING.md",
-    "VERSIONING_POLICY.md",
-    "assets"
+    "LICENSE"
   ],
   "keywords": [
     "eslint",

package/CONTRIBUTING.md

@@ -1,105 +0,0 @@
-# Contributing to eslint-cdk-plugin
-
-Thank you for your interest in contributing to eslint-cdk-plugin!  
-This document provides guidelines and steps for contributing.
-
-## Code of Conduct
-
-By participating in this project, you are expected to uphold our Code of Conduct.  
-Please report unacceptable behavior to `@ren-yamanashi`.
-
-## How to Contribute
-
-### Create Bugs Issue
-
-Before creating issue, please check the existing issues to avoid duplicates.  
-When you create a bug issue, include as following content:
-
-- A clear and descriptive title
-- Steps to reproduce the behavior
-- Expected behavior
-- Actual behavior
-- Code samples if applicable
-- Version information (Node.js, ESLint)
-
-### Create Feature Request Issue
-
-We welcome suggestions for new rules!
-When proposing a new rule:
-
-1. First, check existing rules and issues to avoid duplicates
-2. Create an issue with the following information:
-   - Rule name
-   - Description of the problem the rule solves
-   - Examples of code that should pass/fail
-   - References to AWS CDK best practices if applicable
-
-### Pull Requests
-
-1. Fork the repo and create your branch from `main`
-2. Implement the rules
-3. Implement the test for the rule and make sure it passes. (Tests are run in CI)
-4. Update the documentation
-5. Create a pull request
-
-#### Development Setup
-
-```bash
-# Clone your fork
-https://github.com/ren-yamanashi/eslint-cdk-plugin.git
-
-# Install dependencies
-pnpm install
-
-# Run tests
-pnpm test
-
-# Run linter
-pnpm lint
-```
-
-#### Creating a New Rule
-
-1. Create a new file in `src`(file name should same rule name)
-2. Create corresponding test file in `src/__tests__`
-3. Add rule to `src/index.ts`
-4. Add documentation in `docs`
-
-Note: Writing the document is optional (because it is written using Vitepress and is not yet ready to accept contributions)
-
-Example rule structure:
-
-```typescript
-import { ESLintUtils } from "@typescript-eslint/utils";
-
-export const newRule = ESLintUtils.RuleCreator.withoutDocs({
-  meta: {
-    type: "problem",
-    docs: {
-      description: "Rule description",
-    },
-    messages: {
-      ruleError: "Error message with {{ placeholder }}",
-    },
-    schema: [],
-  },
-  defaultOptions: [],
-  create(context) {
-    // Rule implementation
-  },
-});
-```
-
-## Merge Process
-
-1. Changes are merged to `main`
-2. Maintainers will review and merge
-3. Publish to npm according to Milestone
-
-## Questions?
-
-Feel free to create an issue for any questions about contributing!
-
-## License
-
-By contributing, you agree that your contributions will be licensed under the project's MIT License.

package/VERSIONING_POLICY.md

@@ -1,34 +0,0 @@
-## 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.