Skip to content

Commit 4aebc4e

Browse files
authored
Update CONTRIBUTING.md
Signed-off-by: Manuel <[email protected]>
1 parent eeaee26 commit 4aebc4e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,10 @@ Once you have babel running in watch mode, you can start making changes to parse
242242

243243
#### TypeScript Tests
244244

245-
Type tests are located in [/types/tests.ts](/types/tests.ts) and are responsible for ensure types generated for each class is behaving as expected. Types must be generated using `npm run build:types` and should not be manually changed. These types are `.d.ts` files located in [/types](/types). *Note: Any type changes to `src/Options/index.js` should be manually updated in `types/Options/index.d.ts`.*
245+
Type tests are located in [/types/tests.ts](/types/tests.ts) and are responsible for ensuring that the type generation for each class is behaving as expected. Types are generated by manually running the script `npm run build:types`. The generated types are `.d.ts` files located in [/types](/types) and must not be manually changed after generation.
246+
247+
> [!CAUTION]
248+
> An exemption are type changes to `src/Options/index.js` which must be manually updated in `types/Options/index.d.ts`, as these types are not generated via a script.
246249
247250
When developing type definitions you can use `npm run watch:ts` in order to rebuild your changes automatically upon each save.
248251

0 commit comments

Comments
 (0)