Skip to content

Commit 2da4e76

Browse files
kevinlitchfieldbrandonocasey
authored andcommitted
docs: Expand testing info in CONTRIBUTING.md (#4020)
1 parent 6ad1e5c commit 2da4e76

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,13 +140,17 @@ npm install
140140
141141
#### Running tests
142142

143-
To run the tests all you need to do is run
143+
Tests can be run either from the shell or from the browser.
144+
145+
To run the tests from the shell, just run
144146

145147
```sh
146148
npm test
147149
```
148150

149-
This will build video.js locally and run the tests using [Karma](https://karma-runner.github.io/1.0/index.html) which runs our tests in actual browsers.
151+
This will build video.js locally and run the test suite using [Karma](https://karma-runner.github.io/1.0/index.html), which runs our tests in actual browsers.
152+
153+
To run tests from the browser, first start a local server with `npm start` (this also watches for changes and rebuilds video.js and the test files as necessary). Then navigate to `http://localhost:9999/test`, and you'll see a page that displays the results of all the tests. To rerun the tests after making changes, just refresh the page. To run an individual test, click the "Rerun" link next to the test's title.
150154

151155
#### Building videojs
152156

@@ -275,6 +279,8 @@ Tests attached to bug fixes should fail before the change and succeed with it.
275279
npm test
276280
```
277281
282+
See [Running tests](#running-tests) for more information.
283+
278284
#### Step 6: Push
279285

280286
```sh

0 commit comments

Comments
 (0)