Skip to content

Commit b713ab7

Browse files
committed
Add contribution docs to readme
1 parent b224393 commit b713ab7

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,43 @@ Due to differences between browsers, some error properties such as `message` and
2828

2929
## Contributing
3030

31-
// TODO
31+
To contribute, work on the source files. Then build and run the tests against the built files. Be careful to not introduce syntax that will be transpiled down to unsupported syntax. For example, `for...of` loops will be transpiled to use `Symbol.iterator` which is unavailable in IE.
3232

33-
## Running Tests
33+
### `npm run build`
3434

35-
// TODO
35+
Builds the project into the `build` dir.
36+
37+
### `npm run dev`
38+
39+
Watches source files for changes and rebuilds them into the `build` dir.
40+
41+
### `npm run test`
42+
43+
Builds the source files into the `build` dir and then runs the tests against the built project.
44+
45+
### `npm run test:nobuild`
46+
47+
Runs the tests against the built project without rebuilding first.
48+
49+
This is useful if your debugging in the transpiled code and want to re-run the tests without overwriting any changes you may have made.
50+
51+
### `npm run test:source`
52+
53+
Runs the tests against the unbuilt source files.
54+
55+
This will only work on modern Node.js versions.
56+
57+
### `npm run test:browsers`
58+
59+
Run browser tests against the all targets in the cloud.
60+
61+
Requires airtap credentials to be configured on your machine.
62+
63+
### `npm run test:browsers:local`
64+
65+
Run a local browser test server. No airtap configuration required.
66+
67+
When paired with `npm run dev` any changes you make to the source files will be automatically transpiled and served on the next request to the test server.
3668

3769
## License
3870

0 commit comments

Comments
 (0)