Skip to content

Commit f071d30

Browse files
authoredAug 30, 2022
Move contributing related info out of README to CONTRIBUTING (#50543)
1 parent 488d0ee commit f071d30

File tree

2 files changed

+25
-54
lines changed

2 files changed

+25
-54
lines changed
 

‎CONTRIBUTING.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,33 @@ In general, things we find useful when reviewing suggestions are:
6565
5. Change to the TypeScript folder you made: `cd TypeScript`
6666
6. Install dependencies: `npm ci`
6767
7. Make sure everything builds and tests pass: `gulp runtests-parallel`
68-
8. Open the Typescript folder in your editor.
68+
8. Open the TypeScript folder in your editor.
6969
9. Follow the directions below to add and debug a test.
7070

71+
## Helpful tasks
72+
73+
Running `gulp --tasks --depth 1` provides the full listing, but here are a few common tasks you might use.
74+
75+
```
76+
gulp local # Build the compiler into built/local.
77+
gulp clean # Delete the built compiler.
78+
gulp LKG # Replace the last known good with the built one.
79+
# Bootstrapping step to be executed when the built compiler reaches a stable state.
80+
gulp tests # Build the test infrastructure using the built compiler.
81+
gulp runtests # Run tests using the built compiler and test infrastructure.
82+
# You can override the specific suite runner used or specify a test for this command.
83+
# Use --tests=<testPath> for a specific test and/or --runner=<runnerName> for a specific suite.
84+
# Valid runners include conformance, compiler, fourslash, project, user, and docker
85+
# The user and docker runners are extended test suite runners - the user runner
86+
# works on disk in the tests/cases/user directory, while the docker runner works in containers.
87+
# You'll need to have the docker executable in your system path for the docker runner to work.
88+
gulp runtests-parallel # Like runtests, but split across multiple threads. Uses a number of threads equal to the system
89+
# core count by default. Use --workers=<number> to adjust this.
90+
gulp baseline-accept # This replaces the baseline test results with the results obtained from gulp runtests.
91+
gulp lint # Runs eslint on the TypeScript source.
92+
gulp help # List the above commands.
93+
```
94+
7195
## Tips
7296

7397
### Using a development container

‎README.md

-53
Original file line numberDiff line numberDiff line change
@@ -46,59 +46,6 @@ with any additional questions or comments.
4646
* [Programming handbook](https://www.typescriptlang.org/docs/handbook/intro.html)
4747
* [Homepage](https://www.typescriptlang.org/)
4848

49-
## Building
50-
51-
In order to build the TypeScript compiler, ensure that you have [Git](https://git-scm.com/downloads) and [Node.js](https://nodejs.org/) installed.
52-
53-
Clone a copy of the repo:
54-
55-
```bash
56-
git clone https://github.com/microsoft/TypeScript.git
57-
```
58-
59-
Change to the TypeScript directory:
60-
61-
```bash
62-
cd TypeScript
63-
```
64-
65-
Install [Gulp](https://gulpjs.com/) tools and dev dependencies:
66-
67-
```bash
68-
npm install -g gulp
69-
npm ci
70-
```
71-
72-
Use one of the following to build and test:
73-
74-
```
75-
gulp local # Build the compiler into built/local.
76-
gulp clean # Delete the built compiler.
77-
gulp LKG # Replace the last known good with the built one.
78-
# Bootstrapping step to be executed when the built compiler reaches a stable state.
79-
gulp tests # Build the test infrastructure using the built compiler.
80-
gulp runtests # Run tests using the built compiler and test infrastructure.
81-
# You can override the specific suite runner used or specify a test for this command.
82-
# Use --tests=<testPath> for a specific test and/or --runner=<runnerName> for a specific suite.
83-
# Valid runners include conformance, compiler, fourslash, project, user, and docker
84-
# The user and docker runners are extended test suite runners - the user runner
85-
# works on disk in the tests/cases/user directory, while the docker runner works in containers.
86-
# You'll need to have the docker executable in your system path for the docker runner to work.
87-
gulp runtests-parallel # Like runtests, but split across multiple threads. Uses a number of threads equal to the system
88-
# core count by default. Use --workers=<number> to adjust this.
89-
gulp baseline-accept # This replaces the baseline test results with the results obtained from gulp runtests.
90-
gulp lint # Runs eslint on the TypeScript source.
91-
gulp help # List the above commands.
92-
```
93-
94-
95-
## Usage
96-
97-
```bash
98-
node built/local/tsc.js hello.ts
99-
```
100-
101-
10249
## Roadmap
10350

10451
For details on our planned features and future direction please refer to our [roadmap](https://github.com/microsoft/TypeScript/wiki/Roadmap).

0 commit comments

Comments
 (0)
Please sign in to comment.