Skip to content

Commit

Permalink
more info to run tests
Browse files Browse the repository at this point in the history
  • Loading branch information
marniktln committed Jul 18, 2020
1 parent 0041e3e commit 9478453
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,13 @@ Working on your first Pull Request? You can learn how from this _free_ series,

Node Redis has a full test suite with coverage setup.

To run the tests use the `npm test` command. To check detailed coverage locally run the `npm run coverage` command after
To run the tests, run `npm install` to install all dependencies, and then run `npm test`. To check detailed coverage locally run the `npm run coverage` command after
testing and open the generated `./coverage/index.html` in your browser.

Note that the test suite assumes that a few tools are installed in your environment, such as:
- redis (make sure redis-server is not running when starting the tests, it's part of the test-suite to start it and you'll end up with a "port already in use" error)
- stunnel (for TLS tests)

### Submitting code for review

The bigger the pull request, the longer it will take to review and merge. Where possible try to break down large pull
Expand Down

0 comments on commit 9478453

Please sign in to comment.