From 2da4e76ef01723172d10fcc078fb6399b76c9ee4 Mon Sep 17 00:00:00 2001 From: Kevin Litchfield Date: Thu, 2 Feb 2017 11:19:01 -0500 Subject: [PATCH] docs: Expand testing info in `CONTRIBUTING.md` (#4020) --- CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d010bbf62e..b4fc813bcf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -140,13 +140,17 @@ npm install #### Running tests -To run the tests all you need to do is run +Tests can be run either from the shell or from the browser. + +To run the tests from the shell, just run ```sh npm test ``` -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. +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. + +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. #### Building videojs @@ -275,6 +279,8 @@ Tests attached to bug fixes should fail before the change and succeed with it. npm test ``` +See [Running tests](#running-tests) for more information. + #### Step 6: Push ```sh