Skip to content

Commit adab706

Browse files
committed
Update CONTRIBUTING.md
1 parent 99cc69c commit adab706

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- [Good to Know](#good-to-know)
2222
- [Troubleshooting](#troubleshooting)
2323
- [Please Do's](#please-dos)
24+
- [TypeScript Tests](#typescript-tests)
2425
- [Test against Postgres](#test-against-postgres)
2526
- [Postgres with Docker](#postgres-with-docker)
2627
- [Breaking Changes](#breaking-changes)
@@ -239,6 +240,14 @@ Once you have babel running in watch mode, you can start making changes to parse
239240
* Mocks belong in the `spec/support` folder.
240241
* Please consider if any changes to the [docs](http://docs.parseplatform.org) are needed or add additional sections in the case of an enhancement or feature.
241242

243+
#### TypeScript Tests
244+
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).
246+
247+
When developing type definitions you can use `npm run watch:ts` in order to rebuild your changes automatically upon each save.
248+
249+
Use `npm run test:types` in order to run types tests against generated `.d.ts` files.
250+
242251
### Test against Postgres
243252

244253
If your pull request introduces a change that may affect the storage or retrieval of objects, you may want to make sure it plays nice with Postgres.

0 commit comments

Comments
 (0)