From b1e1ab2f1b1dcc05aa6c3221d2aa11d21bae8b60 Mon Sep 17 00:00:00 2001
From: JounQin <admin@1stg.me>
Date: Sat, 13 Aug 2022 11:02:01 +0800
Subject: [PATCH] docs: add CONTRIBUTING.md

close #222
---
 .changeset/config.json |  1 +
 CONTRIBUTING.md        | 33 +++++++++++++++++++++++++++++++++
 package.json           |  2 +-
 3 files changed, 35 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/.changeset/config.json b/.changeset/config.json
index 12520636c..1c83b5dc6 100644
--- a/.changeset/config.json
+++ b/.changeset/config.json
@@ -11,5 +11,6 @@
   "access": "restricted",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
+  "bumpVersionsWithWorkspaceProtocolOnly": true,
   "ignore": []
 }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..5665be13f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# Contributing
+
+Thanks for contributing!
+
+## Installation
+
+```sh
+git clone https://github.com/ota-meshi/eslint-plugin-svelte.git
+cd eslint-plugin-svelte
+yarn
+```
+
+## Running the tests
+
+```sh
+yarn test
+```
+
+To run the tests with debugging log, you can use `yarn test:debug`.
+
+This is an [ESLint](http://eslint.org) plugin. Documentation for the APIs that it uses can be found on ESLint's [Working with Plugins](http://eslint.org/docs/developer-guide/working-with-plugins) page.
+
+This plugin is used to lint itself. The style is checked when `yarn lint` is run, and the build will fail if there are any linting errors. You can use `yarn lint-fix` to fix some linting errors.
+
+## Commit messages
+
+Please view [commitlint](https://commitlint.js.org) and [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) for more details.
+
+## Publishing
+
+We're using [changesets](https://github.com/changesets/changesets) for version management, CHANGELOG and releasing automatically.
+
+Please view [changesets-bot](https://github.com/apps/changeset-bot) and its [action](https://github.com/changesets/action) for more details.
diff --git a/package.json b/package.json
index 53e6e5037..91ac34d23 100644
--- a/package.json
+++ b/package.json
@@ -34,9 +34,9 @@
     "docs:build": "yarn svelte-kit build",
     "docs:preview": "yarn svelte-kit preview",
     "docs:watch": "yarn svelte-kit dev",
-    "eslint-fix": "eslint . --fix",
     "format-for-gen-file": "eslint src/types-for-node.ts src/utils/rules.ts src/configs --fix",
     "lint": "run-p lint:*",
+    "lint-fix": "yarn lint:es --fix && yarn lint:style --fix",
     "lint:es": "eslint --cache -f friendly .",
     "lint:style": "stylelint --cache .",
     "mocha": "yarn ts ./node_modules/mocha/bin/mocha.js",