Skip to content

Commit 9478453

Browse files
committed
more info to run tests
1 parent 0041e3e commit 9478453

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,13 @@ Working on your first Pull Request? You can learn how from this _free_ series,
8282

8383
Node Redis has a full test suite with coverage setup.
8484

85-
To run the tests use the `npm test` command. To check detailed coverage locally run the `npm run coverage` command after
85+
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
8686
testing and open the generated `./coverage/index.html` in your browser.
8787

88+
Note that the test suite assumes that a few tools are installed in your environment, such as:
89+
- 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)
90+
- stunnel (for TLS tests)
91+
8892
### Submitting code for review
8993

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

0 commit comments

Comments
 (0)