Create CONTRIBUTING.md

zengxiaoluan · Aug 9, 2024 · 23bb909 · 23bb909
1 parent f392634
commit 23bb909
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,13 @@
+# eslint-plugin-jlc Contributing Guide
+
+Hi! We're really excited that you're interested in contributing to this eslint plugin! Before submitting your contribution, please read through the following guide.
+
+## Repo Setup
+
+To develop locally, fork the repository and clone it in your local machine.
+
+To develop and test this repository:
+
+1. Run `npm i` in eslint-plugin-jlc's root folder.
+
+2. Run `yo eslint:rule` in root folder to create a new rule.