File tree Expand file tree Collapse file tree 1 file changed +14
-2
lines changed Expand file tree Collapse file tree 1 file changed +14
-2
lines changed Original file line number Diff line number Diff line change @@ -5,6 +5,8 @@ Thanks for being willing to contribute!
55Working on your first Pull Request? You can learn how from this free series
66[ How to Contribute to an Open Source Project on GitHub] ( https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github ) .
77
8+ Tweaking ESLint rules is mostly about traversing through the AST. [ AST Explorer] ( https://astexplorer.net ) is a great tool that simplifies the process.
9+
810## Project setup
911
10121 . Fork this repository
@@ -63,8 +65,7 @@ each rule has three files named with its identifier (e.g. `no-debug`):
6365
6466Additionally, you need to do a couple of extra things:
6567
66- - Include your rule in the "Supported Rules" table within the [README.md](./README.md).
67- Don't forget to include the proper badges if needed and to sort alphabetically the rules for readability.
68+ - Run `npm run generate:rules-list` to include your rule in the "Supported Rules" table within the [README.md](./README.md)
6869
6970### Custom rule creator
7071
@@ -113,6 +114,17 @@ A couple of things you need to remember when editing already existing rules:
113114
114115## Writing Tests
115116
117+ If you wish to run a single test while developing locally, add `only: true` to the test case:
118+
119+ ```javascript
120+ valid: [
121+ {
122+ only: true,
123+ code: `...`,
124+ },
125+ ];
126+ ```
127+
116128When writing tests for a new or existing rule, please make sure to follow these guidelines:
117129
118130### Write real-ish scenarios
You can’t perform that action at this time.
0 commit comments