From f666295c8fecda5b91293afb5f30231b14e68b66 Mon Sep 17 00:00:00 2001 From: Ajay Poshak Date: Mon, 1 Oct 2018 22:53:16 +0530 Subject: [PATCH 1/3] Add docs for better support of local testing and faster clones --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81ffe06e8e2..a8e3fa31f29 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,6 +47,13 @@ In general, things we find useful when reviewing suggestions are: # Instructions for Contributing Code +## Some things in general + +As Typescript is a big codebase, so some might run into issues while cloning this repo. Hence, it is advisable to use +`git clone --depth=1 ` to clone it faster. + +Run `jake build` after every change. If you want to test it locally in some another project then use `node /built/local/tsc.js` in place of `tsc` in your project. For example, to run `tsc --watch`, use `node /TypeScript/built/local/tsc.js --watch`. + ## Contributing bug fixes 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. From c22e7cade99bd6d238ddddd9c4b294ee3c8c9384 Mon Sep 17 00:00:00 2001 From: Daniel Rosenwasser Date: Mon, 1 Oct 2018 13:25:43 -0700 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8e3fa31f29..a25ed0ad4cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,12 +47,16 @@ In general, things we find useful when reviewing suggestions are: # Instructions for Contributing Code -## Some things in general +## Tips -As Typescript is a big codebase, so some might run into issues while cloning this repo. Hence, it is advisable to use -`git clone --depth=1 ` to clone it faster. +### Faster clones -Run `jake build` after every change. If you want to test it locally in some another project then use `node /built/local/tsc.js` in place of `tsc` in your project. For example, to run `tsc --watch`, use `node /TypeScript/built/local/tsc.js --watch`. +The TypeScript repository is relatively large. To save some time, you might want to clone it without the repo's full history using +`git clone --depth=1` to save time. + +### Using local builds + +Run `jake build` to build a version of the compiler/language service that reflects changes you've made. You can then run `node /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`. ## Contributing bug fixes From 95eec999e8ed4c91bad1f9c72181667df7bb3b40 Mon Sep 17 00:00:00 2001 From: Ryan Cavanaugh Date: Thu, 24 Jan 2019 13:31:44 -0800 Subject: [PATCH 3/3] Tweaks --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a25ed0ad4cd..c707e3c034c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,12 +51,11 @@ In general, things we find useful when reviewing suggestions are: ### Faster clones -The TypeScript repository is relatively large. To save some time, you might want to clone it without the repo's full history using -`git clone --depth=1` to save time. +The TypeScript repository is relatively large. To save some time, you might want to clone it without the repo's full history using `git clone --depth=1`. ### Using local builds -Run `jake build` to build a version of the compiler/language service that reflects changes you've made. You can then run `node /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`. +Run `gulp build` to build a version of the compiler/language service that reflects changes you've made. You can then run `node /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`. ## Contributing bug fixes