From 868638b90367cb8a20f61995c2ceae656e3f092f Mon Sep 17 00:00:00 2001 From: Bethany N Griggs Date: Mon, 18 Jul 2016 16:58:05 +0100 Subject: [PATCH] doc: remove platform assumption from CONTRIBUTING MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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 Reviewed-By: Anna Henningsen --- CONTRIBUTING.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50db95b3de9537..500e0a79d579a0 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: