Skip to content

Commit f666295

Browse files
committed
Add docs for better support of local testing and faster clones
1 parent e1a4c27 commit f666295

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,13 @@ In general, things we find useful when reviewing suggestions are:
4747

4848
# Instructions for Contributing Code
4949

50+
## Some things in general
51+
52+
As Typescript is a big codebase, so some might run into issues while cloning this repo. Hence, it is advisable to use
53+
`git clone --depth=1 <remote-url>` to clone it faster.
54+
55+
Run `jake build` after every change. If you want to test it locally in some another project then use `node <path-to-local-typescript-folder>/built/local/tsc.js` in place of `tsc` in your project. For example, to run `tsc --watch`, use `node <path-to-local-typescript-folder>/TypeScript/built/local/tsc.js --watch`.
56+
5057
## Contributing bug fixes
5158

5259
TypeScript is currently accepting contributions in the form of bug fixes. A bug must have an issue tracking it in the issue tracker that has been approved ("Milestone == Community") by the TypeScript team. Your pull request should include a link to the bug that you are fixing. If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort.

0 commit comments

Comments
 (0)