Skip to content

Commit 76e0e25

Browse files
committed
More docs
1 parent 28f7670 commit 76e0e25

2 files changed

Lines changed: 28 additions & 4 deletions

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,35 @@ If you are completely new to the TypeScript codebase, this YouTube video covers
1212

1313
From there, you can start in the [First Steps to Contributing to the TypeScript Repo](./first_steps.md) consult the [Glossary](./GLOSSARY.md) or dive directly into the [`./codebase/`](./codebase) or [`./systems/`](./systems) folders.
1414

15-
## Compilers in General
15+
## Related TypeScript Info
1616

1717
- Learn how TypeScript works by reading the [mini-TypeScript implementation](https://github.com/sandersn/mini-typescript#mini-typescript)
18+
19+
## Compilers in General
20+
1821
- Recommended link for learning how compilers work: https://c9x.me/compile/bib/
1922

23+
## Interesting PRs
24+
25+
If you learn better by seeing how big features are added to TypeScript, here are a few big well-scoped Pull Requests:
26+
27+
- Unions - [microsoft/TypeScript#824](https://github.com/microsoft/TypeScript/pull/824)
28+
- Type Aliases - [microsoft/TypeScript#957](https://github.com/microsoft/TypeScript/pull/957)
29+
- Async Functions - [microsoft/TypeScript#3078](https://github.com/microsoft/TypeScript/pull/3078)
30+
- TSX - [microsoft/TypeScript#3564](https://github.com/microsoft/TypeScript/pull/3564)
31+
- Intersection Types - [microsoft/TypeScript#3622](https://github.com/microsoft/TypeScript/pull/3622)
32+
- String Literal Types - [microsoft/TypeScript#5185](https://github.com/microsoft/TypeScript/pull/5185)
33+
- JS in TS - [microsoft/TypeScript#5266](https://github.com/microsoft/TypeScript/pull/5266)
34+
- Using JSDoc to extract types - [microsoft/TypeScript#6024](https://github.com/microsoft/TypeScript/pull/6024)
35+
- Nullable types - [microsoft/TypeScript#7140](https://github.com/microsoft/TypeScript/pull/7140)
36+
- Control Flow Analysis - [microsoft/TypeScript#8010](https://github.com/microsoft/TypeScript/pull/8010)
37+
- Mapped Types - [microsoft/TypeScript#12114](https://github.com/microsoft/TypeScript/pull/12114)
38+
- Rest Types - [microsoft/TypeScript#13470](https://github.com/microsoft/TypeScript/pull/13470)
39+
- Strict Functions - [microsoft/TypeScript#18654](https://github.com/microsoft/TypeScript/pull/18654)
40+
- Unknown - [microsoft/TypeScript#24439](https://github.com/microsoft/TypeScript/pull/24439)
41+
- Optional Chaining - [microsoft/TypeScript#33294](https://github.com/microsoft/TypeScript/pull/33294)
42+
- Node ESM Support - [microsoft/TypeScript#45884](https://github.com/microsoft/TypeScript/pull/45884)
43+
2044
# Contributing
2145

2246
This project welcomes contributions and suggestions. Most contributions require you to agree to a

first_steps.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ file I am currently working on.
2222

2323
### Learn the debugger
2424

25-
You'll probably spend a good amount of time in it, if this is completely new to you. Here is a video from
26-
[@alloy](https://github.com/alloy) covering all of the usage of the debugger inside VS Code and how it works.
25+
You'll probably spend a good amount of time in it, if this is completely new to you. [Here is a video from](https://www.youtube.com/watch?v=ChQ_sYjU8tU)
26+
[@alloy](https://github.com/alloy) covering the usage of the debugger inside VS Code, what the buttons do and how it all works.
2727

2828
To test it out, open up `src/compiler/checker.ts` find `function checkSourceFileWorker(node: SourceFile) {` and
2929
add a debugger on the first line in the code. If you open up `tests/cases/fourslash/getDeclarationDiagnostics.ts`
@@ -38,7 +38,7 @@ You'll probably want to add the following to your watch section in VS Code:
3838
- `target.symbol.declarations[0].__debugKind`
3939

4040
This is really useful for keeping track of changing state, and it's pretty often that those are the names of
41-
things you're looking for.
41+
things you're looking for. You can learn some techniques about [debugging the compiler here](https://blog.andrewbran.ch/debugging-the-type-script-codebase/).
4242

4343
### Getting started
4444

0 commit comments

Comments
 (0)