You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Richard Knoll <riknoll@users.noreply.github.com> Richard Knoll <riknoll@microsoft.com>
164
164
Richard Karmazín <richard@karmazin.cz>
165
165
Rowan Wyborn <rwyborn@internode.on.net>
166
-
Ryan Cavanaugh <RyanCavanaugh@users.noreply.github.com> Ryan Cavanaugh <ryan.cavanaugh@microsoft.com> Ryan Cavanaugh <ryanca@microsoft.com>
166
+
Ryan Cavanaugh <RyanCavanaugh@users.noreply.github.com> Ryan Cavanaugh <ryan.cavanaugh@microsoft.com> Ryan Cavanaugh <ryanca@microsoft.com> Ryan Cavanaugh <the.ryan.cavanaugh@gmail.com>
167
167
Ryohei Ikegami <iofg2100@gmail.com>
168
168
Sarangan Rajamanickam <sarajama@microsoft.com>
169
169
Sébastien Arod <sebastien.arod@gmail.com>
@@ -340,4 +340,22 @@ EcoleKeine <Ecole_k@qq.com> # Ecole Keine
340
340
Khải <hvksmr1996@gmail.com>
341
341
rhysd <lin90162@yahoo.co.jp> # @rhysd
342
342
Zen <843968788@qq.com> Zzzen <843968788@qq.com> # @Zzzen
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-14Lines changed: 21 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ Design changes will not be accepted at this time. If you have a design change pr
61
61
62
62
You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright.
63
63
64
-
Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally. Alternatively, download the agreement ([Microsoft Contribution License Agreement.docx](https://www.codeplex.com/Download?ProjectName=typescript&DownloadId=822190) or [Microsoft Contribution License Agreement.pdf](https://www.codeplex.com/Download?ProjectName=typescript&DownloadId=921298)), sign, scan, and email it back to <cla@microsoft.com>. Be sure to include your github user name along with the agreement. Once we have received the signed CLA, we'll review the request.
64
+
Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally. Alternatively, download the agreement ([Microsoft Contribution License Agreement.pdf](https://opensource.microsoft.com/pdf/microsoft-contribution-license-agreement.pdf)), sign, scan, and email it back to <cla@microsoft.com>. Be sure to include your github user name along with the agreement. Once we have received the signed CLA, we'll review the request.
65
65
66
66
## Housekeeping
67
67
@@ -72,7 +72,7 @@ Your pull request should:
72
72
* Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR)
73
73
* It is desirable, but not necessary, for the tests to pass at each commit
74
74
* Have clear commit messages
75
-
* e.g. "Refactor feature", "Fix issue", "Add tests for issue"
75
+
* e.g. "Minor refactor in goToTypeDefinition", "Fix iterated type in for-await-of", "Add test for preserveWatchOutput on command line"
76
76
* Include adequate tests
77
77
* At least one test should fail in the absence of your non-test code changes. If your PR does not match this criteria, please specify why
78
78
* Tests should include reasonable permutations of the target fix/change
@@ -82,19 +82,26 @@ Your pull request should:
82
82
* To avoid line ending issues, set `autocrlf = input` and `whitespace = cr-at-eol` in your git configuration
83
83
84
84
## Contributing `lib.d.ts` fixes
85
-
86
-
The library sources are in: [src/lib](https://github.com/Microsoft/TypeScript/tree/master/src/lib)
87
85
88
-
Library files in `built/local/` are updated by running
89
-
```Shell
86
+
There are three relevant locations to be aware of when it comes to TypeScript's library declaration files:
87
+
88
+
*`src/lib`: the location of the sources themselves.
89
+
*`lib`: the location of the last-known-good (LKG) versions of the files which are updated periodically.
90
+
*`built/local`: the build output location, including where `src/lib` files will be copied to.
91
+
92
+
Any changes should be made to [src/lib](https://github.com/Microsoft/TypeScript/tree/master/src/lib). **Most** of these files can be updated by hand, with the exception of any generated files (see below).
93
+
94
+
Library files in `built/local/` are updated automatically by running the standard build task:
95
+
96
+
```sh
90
97
jake
91
98
```
92
99
93
-
The files in `lib/` are used to bootstrap compilation and usually do not need to be updated.
100
+
The files in `lib/` are used to bootstrap compilation and usually **should not**be updated unless publishing a new version or updating the LKG.
94
101
95
-
#### `src/lib/dom.generated.d.ts` and `src/lib/webworker.generated.d.ts`
102
+
###Modifying generated library files
96
103
97
-
These two files represent the DOM typings and are auto-generated. To make any modifications to them, please submit a PR to https://github.com/Microsoft/TSJS-lib-generator
104
+
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 tohttps://github.com/Microsoft/TSJS-lib-generator
98
105
99
106
## Running the Tests
100
107
@@ -104,7 +111,7 @@ To run all tests, invoke the `runtests-parallel` target using jake:
104
111
jake runtests-parallel
105
112
```
106
113
107
-
This run will all tests; to run only a specific subset of tests, use:
114
+
This will run all tests; to run only a specific subset of tests, use:
108
115
109
116
```Shell
110
117
jake runtests tests=<regex>
@@ -137,10 +144,10 @@ You can specify which browser to use for debugging. Currently Chrome and IE are
You can debug with VS Code or Node instead with `jake runtests debug=true`:
147
+
You can debug with VS Code or Node instead with `jake runtests inspect=true`:
141
148
142
149
```Shell
143
-
jake runtests tests=2dArrays debug=true
150
+
jake runtests tests=2dArrays inspect=true
144
151
```
145
152
146
153
## Adding a Test
@@ -153,7 +160,7 @@ The supported names and values are the same as those supported in the compiler i
153
160
They are useful for tests relating to modules.
154
161
See below for examples.
155
162
156
-
**Note** that if you have a test corresponding to a specific spec compliance item, you can place it in `tests\cases\conformance` in an appropriately-named subfolder.
163
+
**Note** that if you have a test corresponding to a specific spec compliance item, you can place it in `tests\cases\conformance` in an appropriately-named subfolder.
157
164
**Note** that filenames here must be distinct from all other compiler testcase names, so you may have to work a bit to find a unique name if it's something common.
158
165
159
166
### Tests for multiple files
@@ -194,6 +201,6 @@ to establish the new baselines as the desired behavior. This will change the fil
194
201
## Localization
195
202
196
203
All strings the user may see are stored in [`diagnosticMessages.json`](./src/compiler/diagnosticMessages.json).
197
-
If you make changes to it, run `jake generate-diagnostics` to push them to the `Diagnostic` interface in [`diagnosticInformationMap.generated.ts`](./src/compiler/diagnosticInformationMap.generated.ts).
204
+
If you make changes to it, run `jake generate-diagnostics` to push them to the `Diagnostic` interface in `diagnosticInformationMap.generated.ts`.
198
205
199
206
See [coding guidelines on diagnostic messages](https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines#diagnostic-messages).
0 commit comments