Skip to content

Commit c22e7ca

Browse files
Update CONTRIBUTING.md
1 parent f666295 commit c22e7ca

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,16 @@ In general, things we find useful when reviewing suggestions are:
4747

4848
# Instructions for Contributing Code
4949

50-
## Some things in general
50+
## Tips
5151

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.
52+
### Faster clones
5453

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`.
54+
The TypeScript repository is relatively large. To save some time, you might want to clone it without the repo's full history using
55+
`git clone --depth=1` to save time.
56+
57+
### Using local builds
58+
59+
Run `jake build` to build a version of the compiler/language service that reflects changes you've made. You can then run `node <repo-root>/built/local/tsc.js` in place of `tsc` in your project. For example, to run `tsc --watch` from within the root of the repository on a file called `test.ts`, you can run `node ./built/local/tsc.js --watch test.ts`.
5660

5761
## Contributing bug fixes
5862

0 commit comments

Comments
 (0)