Skip to content

Commit 868638b

Browse files
BethGriggsaddaleax
authored andcommitted
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: #7646 PR-URL: #7783 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent 68ac0d0 commit 868638b

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

CONTRIBUTING.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -135,23 +135,35 @@ $ git fetch upstream
135135
$ git rebase upstream/master
136136
```
137137

138-
139138
### Step 5: Test
140139

141140
Bug fixes and features **should come with tests**. Add your tests in the
142141
`test/parallel/` directory. For guidance on how to write a test for the Node.js
143142
project, see this [guide](./doc/guides/writing_tests.md). Looking at other tests
144143
to see how they should be structured can also help.
145144

145+
To run the tests on Unix / OS X:
146+
146147
```text
147148
$ ./configure && make -j8 test
148149
```
149150

151+
Windows:
152+
153+
```text
154+
> vcbuild test
155+
```
156+
157+
(See the [BUILDING.md](./BUILDING.md) for more details.)
158+
150159
Make sure the linter is happy and that all tests pass. Please, do not submit
151160
patches that fail either check.
152161

153-
Running `make test` will run the linter as well unless one or more tests fail.
154-
If you want to run the linter without running tests, use `make lint`.
162+
Running `make test`/`vcbuild test` will run the linter as well unless one or
163+
more tests fail.
164+
165+
If you want to run the linter without running tests, use
166+
`make lint`/`vcbuild jslint`.
155167

156168
If you are updating tests and just want to run a single test to check it, you
157169
can use this syntax to run it exactly as the test harness would:

0 commit comments

Comments
 (0)