From f1cdbb23143047bdc4b5e5fe9d2b1d01b873ae7b Mon Sep 17 00:00:00 2001 From: Kevin Litchfield Date: Wed, 1 Feb 2017 20:14:23 -0500 Subject: [PATCH 1/2] Expand testing info in CONTRIBUTING.md --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d010bbf62e..0fd21f6ff6 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 @@ -271,9 +275,7 @@ Fixes #123. The footer can contain Fixes messages. Any code change should come with corresponding test changes. Especially bug fixes. Tests attached to bug fixes should fail before the change and succeed with it. -```sh -npm test -``` +Tests can be run either from the shell (`npm test`) or from the browser(`npm start`; `http://localhost:9999/test`). See [Running tests](#running-tests) for more information. #### Step 6: Push From 6e50ad25f010852f5b0ec7d3a9441233daccf78b Mon Sep 17 00:00:00 2001 From: Kevin Litchfield Date: Thu, 2 Feb 2017 00:20:58 -0500 Subject: [PATCH 2/2] Don't discuss `npm start` in "Making Changes" --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fd21f6ff6..b4fc813bcf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -275,7 +275,11 @@ Fixes #123. The footer can contain Fixes messages. Any code change should come with corresponding test changes. Especially bug fixes. Tests attached to bug fixes should fail before the change and succeed with it. -Tests can be run either from the shell (`npm test`) or from the browser(`npm start`; `http://localhost:9999/test`). See [Running tests](#running-tests) for more information. +```sh +npm test +``` + +See [Running tests](#running-tests) for more information. #### Step 6: Push