Browse Source

doc: remove platform assumption from CONTRIBUTING

- Specify that the ‘make test’ commands are Unix/OS X specific.
- Link to BUILDING.md for other platform commands.

Fixes: https://github.com/nodejs/node/issues/7646
PR-URL: https://github.com/nodejs/node/pull/7783
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
v6.x
Bethany N Griggs 9 years ago
committed by cjihrig
parent
commit
14a0c3181c
  1. 18
      CONTRIBUTING.md

18
CONTRIBUTING.md

@ -135,7 +135,6 @@ $ git fetch upstream
$ git rebase upstream/master $ git rebase upstream/master
``` ```
### Step 5: Test ### Step 5: Test
Bug fixes and features **should come with tests**. Add your tests in the Bug fixes and features **should come with tests**. Add your tests in the
@ -143,15 +142,28 @@ Bug fixes and features **should come with tests**. Add your tests in the
project, see this [guide](./doc/guides/writing_tests.md). Looking at other tests project, see this [guide](./doc/guides/writing_tests.md). Looking at other tests
to see how they should be structured can also help. to see how they should be structured can also help.
To run the tests on Unix / OS X:
```text ```text
$ ./configure && make -j8 test $ ./configure && make -j8 test
``` ```
Windows:
```text
> vcbuild test
```
(See the [BUILDING.md](./BUILDING.md) for more details.)
Make sure the linter is happy and that all tests pass. Please, do not submit Make sure the linter is happy and that all tests pass. Please, do not submit
patches that fail either check. patches that fail either check.
Running `make test` will run the linter as well unless one or more tests fail. Running `make test`/`vcbuild test` will run the linter as well unless one or
If you want to run the linter without running tests, use `make lint`. more tests fail.
If you want to run the linter without running tests, use
`make lint`/`vcbuild jslint`.
If you are updating tests and just want to run a single test to check it, you If you are updating tests and just want to run a single test to check it, you
can use this syntax to run it exactly as the test harness would: can use this syntax to run it exactly as the test harness would:

Loading…
Cancel
Save