Skip to content

Commit c7097d8

Browse files
docs: update contributing.md after typescript migration (#204)
1 parent b6fcc42 commit c7097d8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ Based on [ESLint's Rule Naming Conventions](https://eslint.org/docs/developer-gu
5757
In the [same way as ESLint](https://eslint.org/docs/developer-guide/working-with-rules),
5858
each rule has three files named with its identifier (e.g. `no-debug`):
5959
60-
- in the `lib/rules` directory: a source file (e.g. `no-debug.js`)
61-
- in the `tests/lib/rules` directory: a test file (e.g. `no-debug.js`)
60+
- in the `lib/rules` directory: a source file (e.g. `no-debug.ts`)
61+
- in the `tests/lib/rules` directory: a test file (e.g. `no-debug.ts`)
6262
- in the `docs/rules` directory: a Markdown documentation file (e.g. `no-debug.md`)
6363
6464
Additionally, you need to do a couple of extra things:
6565
66-
- Import the new rule in `lib/index.js` and include it
66+
- Import the new rule in `lib/index.ts` and include it
6767
in `rules` constant (there is a test which will make sure you did
6868
this). Remember to include your rule under corresponding `config` if necessary
6969
(a snapshot test will check this too, but you can update it just running
@@ -75,8 +75,8 @@ Additionally, you need to do a couple of extra things:
7575
7676
A couple of things you need to remember when editing already existing rules:
7777
78-
- If renaming a rule, make sure to update all points mentioned in
79-
"Adding new rules" section.
78+
- If renaming a rule, make sure to update all points mentioned in the
79+
"[Adding new rules"](#adding-new-rules) section.
8080
- Try to add tests to cover the changes introduced, no matter if that's
8181
a bug fix or a new feature.
8282

0 commit comments

Comments
 (0)