docs: explain how to start working on a new rule

yudai-nkt · Sep 4, 2023 · 9ee70a8 · 9ee70a8
1 parent 12fb86a
commit 9ee70a8
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,11 @@ Enable the plugin in the `plugins` section, and configure rules according to you
 <!-- rules table ends -->
 <!-- prettier-ignore-end -->
 
+## Contribution
+
+When you add a new lint rule, please run `npm run new-rule`.
+This will scaffold source, test, and documentation files.
+
 ## License
 
 This package is distributed under the MIT License.