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
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/Feature_request.md
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -32,8 +32,10 @@ What shortcomings exist with current approaches?
32
32
## Checklist
33
33
34
34
My suggestion meets these guidelines:
35
-
*[ ] This wouldn't be a breaking change in existing TypeScript / JavaScript code
35
+
36
+
*[ ] This wouldn't be a breaking change in existing TypeScript/JavaScript code
36
37
*[ ] This wouldn't change the runtime behavior of existing JavaScript code
37
38
*[ ] This could be implemented without emitting different JS based on the types of the expressions
38
-
*[ ] This isn't a runtime feature (e.g. new expression-level syntax)
39
+
*[ ] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
40
+
*[ ] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+27-10Lines changed: 27 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -47,6 +47,16 @@ In general, things we find useful when reviewing suggestions are:
47
47
48
48
# Instructions for Contributing Code
49
49
50
+
## Tips
51
+
52
+
### Faster clones
53
+
54
+
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`.
55
+
56
+
### Using local builds
57
+
58
+
Run `gulp build` to build a version of the compiler/language service that reflects changes you've made. You can then run `node <repo-root>/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`.
59
+
50
60
## Contributing bug fixes
51
61
52
62
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.
@@ -82,19 +92,26 @@ Your pull request should:
82
92
* To avoid line ending issues, set `autocrlf = input` and `whitespace = cr-at-eol` in your git configuration
83
93
84
94
## Contributing `lib.d.ts` fixes
85
-
86
-
The library sources are in: [src/lib](https://github.com/Microsoft/TypeScript/tree/master/src/lib)
87
95
88
-
Library files in `built/local/` are updated by running
89
-
```Shell
96
+
There are three relevant locations to be aware of when it comes to TypeScript's library declaration files:
97
+
98
+
*`src/lib`: the location of the sources themselves.
99
+
*`lib`: the location of the last-known-good (LKG) versions of the files which are updated periodically.
100
+
*`built/local`: the build output location, including where `src/lib` files will be copied to.
101
+
102
+
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).
103
+
104
+
Library files in `built/local/` are updated automatically by running the standard build task:
105
+
106
+
```sh
90
107
jake
91
108
```
92
109
93
-
The files in `lib/` are used to bootstrap compilation and usually do not need to be updated.
110
+
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
111
95
-
#### `src/lib/dom.generated.d.ts` and `src/lib/webworker.generated.d.ts`
112
+
###Modifying generated library files
96
113
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
114
+
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
115
99
116
## Running the Tests
100
117
@@ -137,10 +154,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`:
157
+
You can debug with VS Code or Node instead with `jake runtests inspect=true`:
141
158
142
159
```Shell
143
-
jake runtests tests=2dArrays debug=true
160
+
jake runtests tests=2dArrays inspect=true
144
161
```
145
162
146
163
## Adding a Test
@@ -153,7 +170,7 @@ The supported names and values are the same as those supported in the compiler i
153
170
They are useful for tests relating to modules.
154
171
See below for examples.
155
172
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.
173
+
**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
174
**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.
0 commit comments