Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand testing info in CONTRIBUTING.md #4020

Merged
merged 2 commits into from
Feb 2, 2017
Merged

Expand testing info in CONTRIBUTING.md #4020

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1cdbb2
Expand testing info in CONTRIBUTING.md
kevinlitchfield Feb 2, 2017
6e50ad2
Don't discuss `npm start` in "Making Changes"
kevinlitchfield Feb 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down