Skip to content

Commit d164509

Browse files
authored
Update README.md
1 parent 1df86e0 commit d164509

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
AppVeyor Status: [![Build status](https://ci.appveyor.com/api/projects/status/8oj3j7u6nvag1xvu/branch/master?svg=true)](https://ci.appveyor.com/project/zhengbli/tsjs-lib-generator/branch/master)
44
Travis CI Status: [![Build Status](https://travis-ci.org/Microsoft/TSJS-lib-generator.svg?branch=master)](https://travis-ci.org/Microsoft/TSJS-lib-generator)
55

6-
This tool is used to generate `dom.generated.d.ts`, `webworker.generated.d.ts` an`dom.es6.generated.d.ts` for TypeScript.
6+
This tool is used to generate `dom.generated.d.ts`, `webworker.generated.d.ts` and `dom.es6.generated.d.ts` for TypeScript.
77
The input file is the XML spec file generated by the Microsoft Edge browser.
88

99
## Build Instructions
@@ -15,12 +15,15 @@ Note: for OS X and Unix users, [Mono 4.2 or higher](http://www.mono-project.com/
1515

1616
## Contribution Guidelines
1717

18-
The `dom.generated.d.ts`, `webworker.generated.d.ts` an`dom.es6.generated.d.ts` files from the TypeScript repo are used as baselines.
18+
The `dom.generated.d.ts`, `webworker.generated.d.ts` and `dom.es6.generated.d.ts` files from the TypeScript repo are used as baselines.
1919
For each pull request, we will run the script and compare the generated files with the baseline files.
2020
In order to make the tests pass, please update the baseline as well in any pull requests.
2121

2222
For common changes, it is sufficient to change the json files.
23-
There are three json files that are used to alter the file generation: `addedTypes.json`, `overridingTypes.json`, and `removedTypes.json`.
23+
There are three json files that are typically used to alter the type generation: `addedTypes.json`, `overridingTypes.json`, and `removedTypes.json`.
24+
`comments.json` can used to add comments to the types.
25+
Finally, `knownWorkerEnums` and `knownWorkerInterfaces` determine which types are available in a WebWorker environment.
26+
2427
The format of each file can be inferred from their existing content.
2528

2629
The common steps to send a pull request are:
@@ -62,4 +65,4 @@ A "Living Standard" ([example](https://xhr.spec.whatwg.org/)) should be added he
6265
- `overridingTypes.json`: types that are defined in the spec file but has a better or more up-to-date definitions in the json files.
6366
- `removedTypes.json`: types that are defined in the spec file but should be removed.
6467
- `comments.json`: comment strings to be embedded in the generated .js files.
65-
- `sample.json`: sample json file used to tell F# json type provider that structure of the json files. The content of it is not used anywhere.
68+
- `sample.json`: sample json file used to tell F# json type provider that structure of the json files. The content of it is not used anywhere. **Do not edit this file**.

0 commit comments

Comments
 (0)