summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorBethany N Griggs <Bethany.Griggs@uk.ibm.com>2016-07-18 16:58:05 +0100
committerAnna Henningsen <anna@addaleax.net>2016-07-27 23:35:59 +0200
commit868638b90367cb8a20f61995c2ceae656e3f092f (patch)
treeab03566c2c04f8cede71b4c10f8b1af26caa1312 /CONTRIBUTING.md
parent68ac0d0d7d82f8fde114ef4644c59ae6060e0b01 (diff)
downloadandroid-node-v8-868638b90367cb8a20f61995c2ceae656e3f092f.tar.gz
android-node-v8-868638b90367cb8a20f61995c2ceae656e3f092f.tar.bz2
android-node-v8-868638b90367cb8a20f61995c2ceae656e3f092f.zip
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>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 50db95b3de..500e0a79d5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -135,7 +135,6 @@ $ git fetch upstream
$ git rebase upstream/master
```
-
### Step 5: Test
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
to see how they should be structured can also help.
+To run the tests on Unix / OS X:
+
```text
$ ./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
patches that fail either check.
-Running `make test` will run the linter as well unless one or more tests fail.
-If you want to run the linter without running tests, use `make lint`.
+Running `make test`/`vcbuild test` will run the linter as well unless one or
+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
can use this syntax to run it exactly as the test harness would: