Skip to content

Commit 1eb276f

Browse files
author
aghArdeshir
authored
Add reference to TypeScript-Compiler-Notes in CONTRIBUTING.md (microsoft#49689)
I tried a lot in the past few weeks to find a documentation on TS Compiler, I couldn't find any. I opened an issue asking for the documentation: microsoft/TypeScript-Website#2428 and then I got to know the TypeScript-Compiler-Notes repository. I believe it could help a lot if it was in CONTRIBUTING.md file.
1 parent 2f86a83 commit 1eb276f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,10 @@ The files in `lib/` are used to bootstrap compilation and usually **should not**
148148

149149
The files `src/lib/dom.generated.d.ts` and `src/lib/webworker.generated.d.ts` both represent type declarations for the DOM and are auto-generated. To make any modifications to them, you will have to direct changes to https://github.com/Microsoft/TSJS-lib-generator
150150

151+
## Documentation on TypeScript Compiler
152+
153+
If you need a head start understanding how the compiler works, or how the code in different parts of the compiler works, there is a separate repo: [TypeScript Compiler Notes](https://github.com/microsoft/TypeScript-Compiler-Notes). As the name implies, it contains notes understood by different engineers about different parts of the compiler.
154+
151155
## Running the Tests
152156

153157
To run all tests, invoke the `runtests-parallel` target using gulp:

0 commit comments

Comments
 (0)