Skip to content

docs: Add TypeScript instructions and refactor Contributing guide #2463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Mar 17, 2025
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,16 @@ To run the integration tests, you will need a valid mongodb running on your loca

Use `npm run integration` in order to run the integration tests. If you have the vscode Jasmine extension installed (as recommended), you can run your tests by clicking the *Run* or the *Debug* lens that appears near by the test.

#### TypeScript Types tests

Those 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).

When developing type definitions you can use `npm run watch:ts` in order to rebuild your changes upon each save.

Use `npm run test:types` in order to run types tests against generated `.d.ts` files.

### Pull Requests

We actively welcome your pull requests. When we get one, we'll run some Parse-specific integration tests on it first. From here, we'll need to get a core member to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process.
Expand Down