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: README.md
+14-5
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,14 @@ To test:
25
25
npm run test
26
26
```
27
27
28
+
To deploy:
29
+
30
+
```sh
31
+
npm run migrate
32
+
```
33
+
34
+
The script will look in for a clone of the TypeScript repo in "../TypeScript", or "./TypeScript" to move the generated files in.
35
+
28
36
## Contribution Guidelines
29
37
30
38
The `dom.generated.d.ts`, `webworker.generated.d.ts` and `dom.iterable.generated.d.ts` files from the TypeScript repo are used as baselines.
@@ -53,9 +61,9 @@ The common steps to send a pull request are:
53
61
54
62
### What are the TypeScript team's heuristics for PRs to the DOM APIs
55
63
56
-
Changes to this repo can have pretty drastic ecosystem effects, because these types are included by default in TypeScript.
64
+
Changes to this repo can have pretty drastic ecosystem effects, because these types are included by default in TypeScript.
57
65
Due to this, we tend to be quite conservative with our approach to introducing changes.
58
-
To give you a sense of whether we will accept changes, you can use these heuristics to know up-front if we'll be open to merging.
66
+
To give you a sense of whether we will accept changes, you can use these heuristics to know up-front if we'll be open to merging.
59
67
60
68
#### Fixes
61
69
@@ -71,9 +79,9 @@ To give you a sense of whether we will accept changes, you can use these heurist
71
79
> For example, adding a new spec or subsection via a new or updated IDL file
72
80
73
81
- Does the new objects or fields show up in [mdn/browser-compat-data](https://github.com/mdn/browser-compat-data)? If not, it's likely too soon.
74
-
- Is the IDL source from WHATWG?
75
-
- Are the additions available in at least two of Firefox, Safari and Chromium?
76
-
- Is the IDL source from W3C?
82
+
- Is the IDL source from WHATWG?
83
+
- Are the additions available in at least two of [Firefox](https://searchfox.org/mozilla-central/search?q=&path=), [Safari](https://webkit-search.igalia.com/webkit/search?q=&path=) and Chromium?
84
+
- Is the IDL source from W3C?
77
85
- What stage of the [W3C process](https://en.wikipedia.org/wiki/World_Wide_Web_Consortium#Specification_maturation) is the proposal for these changes: We aim for Proposed recommendation, but can accept Candidate recommendation for stable looking proposals.
78
86
- If it's at Working draft the additions available in all three of Firefox, Safari and Chromium
79
87
- Could any types added at the global scope have naming conflicts?
@@ -103,3 +111,4 @@ To give you a sense of whether we will accept changes, you can use these heurist
103
111
-`overridingTypes.json`: types that are defined in the spec file but has a better or more up-to-date definitions in the json files.
104
112
-`removedTypes.json`: types that are defined in the spec file but should be removed.
105
113
-`comments.json`: comment strings to be embedded in the generated .js files.
114
+
-`deprecatedMessage.json`: the reason why one type is deprecated. The reason why it is a separate file rather than merge in comment.json is mdn/apiDescriptions.json would also possibly be deprecated.
0 commit comments