Skip to content

Commit c371bdf

Browse files
committed
Merge pull request #11 from Microsoft/updateReadme
update readme
2 parents 3559e64 + 3de3955 commit c371bdf

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@ To build the tool, simply clone the repo, and run `build.cmd` in command line or
1010
- `JS.fs`: handles the emitting of the `domWeb.js` and `domWindows.js`
1111

1212
## Contribution Guide
13-
The `dom.generated.d.ts` and `webworker.generated.d.ts` files that are used in TypeScript repo `master` branch are used as baselines. For each pull request, we will try run the script and compare the generated files with the baseline files. So to make the tests passed, please update the baseline and the code at the same pull request.
13+
The `dom.generated.d.ts` and `webworker.generated.d.ts` files in the TypeScript repo are used as baselines.
14+
For each pull request, we will run the script and compare the generated files with the baseline files.
15+
In order to make the tests pass, please update the baseline as well in any pull requests.
16+
17+
For common changes, it is sufficient to change the json files.
18+
There are three json files that are used to alter the file generation: `addedTypes.json`, `overridingTypes.json` and `removedTypes.json`.
19+
The format of each file can be inferred from their existing content.
1420

1521
## Input Files:
1622
- `browser.webidl.xml`: the XML spec file generated by Microsoft Edge (due to the different updating schedules between Edge and TypeScript, this may **not** be the most up-to-date version of the spec.);

0 commit comments

Comments
 (0)