Skip to content

Commit d759d4e

Browse files
BethGriggsMylesBorins
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 b01854d commit d759d4e

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
@@ -136,23 +136,35 @@ $ git fetch upstream
136136
$ git rebase upstream/master
137137
```
138138

139-
140139
### Step 5: Test
141140

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

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

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

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

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

0 commit comments

Comments
 (0)