doc: Change test option at STEP 5: Test in CONTRIBUTING.md #12830

kysnm · 2017-05-04T15:30:33Z

Checklist

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

none

lpinca · 2017-05-04T16:08:05Z

CONTRIBUTING.md

+You can run tests in parallel with option `-J`
+
+```text
+$ python tools/test.py -J --mode=release parallel


There is make test-parallel for this so I wouldn't add it.

Thank you for reviewing.
I will remove this.

vsemozhetbyt

LGTM with a nit: line 191 is 81 characters long, and this may break approaching doc linting. Could you please wrap this line, say, before the last word?

kysnm · 2017-05-04T17:32:10Z

I fix it.
and check to the make lint

Do I have to squash this branch?

lpinca · 2017-05-04T17:33:42Z

CONTRIBUTING.md

+$ python tools/test.py --mode=release parallel/test-stream2-transform
+```
+
+If you want to check the other option, please refer the help with option


Nit: take this with a grain of salt as I'm not a native speaker but maybe it better to use "the other options, please refer to the help with the option".

vsemozhetbyt · 2017-05-04T17:36:07Z

Thank you! I may squash if it is not difficult. Or this may be squashed before landing by somebody else.

kysnm · 2017-05-04T17:39:34Z

@vsemozhetbyt
I understand it 😄

lpinca · 2017-05-04T17:46:38Z

@kysnm I think the last commit removed more words than it had to :)

kysnm · 2017-05-04T17:55:50Z

@lpinca
I'm sorry 💦
Does this commit is match with your pointed out?

lpinca · 2017-05-04T18:02:11Z

Yes, thank you!

kysnm · 2017-05-04T18:05:32Z

Thank you for your reviewing.
I'm glad to can contribute this 🎉

aqrln · 2017-05-04T18:11:00Z

CONTRIBUTING.md

+$ python tools/test.py --mode=release parallel/test-stream2-transform
+```
+
+If you want to check the other option, please refer to the help with the option


"...other options..."

Also, can you please avoid using personal pronouns like "you"?

EDIT: on the other hand, that's how this document is already written, and such wording is common in it.

aqrln · 2017-05-04T18:11:41Z

CONTRIBUTING.md

+```
+
+If you want to check the other option, please refer to the help with the option
+ `--help`


Unnecessary space at the beginning of the line.

kysnm · 2017-05-04T18:48:59Z

Fixed

gibfahn · 2017-05-05T12:20:14Z

CONTRIBUTING.md

@@ -185,7 +185,14 @@ 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:

 ```text
-$ python tools/test.py -v --mode=release parallel/test-stream2-transform
+$ python tools/test.py --mode=release parallel/test-stream2-transform


Can we add a -J? Given that it says "exactly as the test harness would" we should probably be exact:

-$ python tools/test.py --mode=release parallel/test-stream2-transform +$ python tools/test.py -J --mode=release parallel/test-stream2-transform

LGTM otherwise.

I think it would be run "exactly as the test harness would" either way given that tools/test.py is the test harness, regardless of the options.

I think that users would understand by looking at help.

I think it would be run "exactly as the test harness would" either way given that tools/test.py is the test harness, regardless of the options.

I assume the test harness means make test, otherwise that part of the sentence is kinda meaningless. The reason I think this is necessary is that using -J can cause subtle bugs (when tests interact with each other), and that is impossible to debug if you don't use the flag by default.

The reason I think this is necessary is that using -J can cause subtle bugs (when tests interact with each other)

Yeah, I agree with that if we are talking about running multiple tests. But that sentence is about running a single test, isn't it? Do I miss the point?

Wouldn't a PR changing -J to default (with -j1 as the opt-out) make sense?

Maaaybe, I think I'd be +1 on that, but I suspect it might be contentious...

Other option, a wrapper script test-ci (.sh & .cmd).
This one I'm doing

Other option, a wrapper script test-ci (.sh & .cmd).

Doesn't that duplicate the Makefile and vcbuild.bat test-ci target? What's the gain?

It'll take $*, so it's useful for single files, or single suits.
I don't know about make test-ci but vcbuild test-ci builds first (with Feet of clay), very demotivating.

PTAL #12874

refack · 2017-05-06T13:11:41Z

CONTRIBUTING.md

-If you want to check the other option, please refer to the help with the option
- `--help`
+If you want to check the other options, please refer to the help with the
+option `--help`


Nit: please refer to the help with the option `--help` => please refer to the documentation by using the `--help` option

I think the word documentation gives the users impression that they should see the https://nodejs.org/en/docs/

Several options

please refer to the built in documentation by using the `--help` option

please refer to the help by using the `--help` option

please refer to the help by passing the `--help` flag

Thank you for suggestions
I will change to the No.2

kysnm · 2017-05-10T05:31:20Z

Is there anything i should fix the patch, yet?
Please let me know 🙏

gibfahn · 2017-05-10T09:41:31Z

I'd still like the -J (unless someone is -1 on it).

-$ python tools/test.py --mode=release parallel/test-stream2-transform
+$ python tools/test.py -J --mode=release parallel/test-stream2-transform

kysnm · 2017-05-11T15:53:47Z

Added the option -J, because no one is -1 on comment above.

kysnm · 2017-05-11T16:10:56Z

@aqrln
How do you think?

aqrln

LGTM, thanks!

kysnm · 2017-05-12T00:03:58Z

Thanks for all reviewers.
I'm looking forward to that this patch will be landed
(if there is no more point out 😁 )

PR-URL: nodejs#12830 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Alexey Orlenko <[email protected]>

refack · 2017-05-12T00:42:17Z

Landed in d7d16f7

PR-URL: nodejs#12830 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Alexey Orlenko <[email protected]>

PR-URL: #12830 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Alexey Orlenko <[email protected]>

doc: Change test option at STEP 5: Test in CONTRIBUTING.md

ce884c0

nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 4, 2017

lpinca requested review from MylesBorins and removed request for MylesBorins May 4, 2017 15:56

lpinca reviewed May 4, 2017

View reviewed changes

vsemozhetbyt added test Issues and PRs related to the tests. tools Issues and PRs related to the tools directory. labels May 4, 2017

Remove unnecessary sentence

7832bb6

vsemozhetbyt approved these changes May 4, 2017

View reviewed changes

Follow the doc linting

def6cf0

lpinca reviewed May 4, 2017

View reviewed changes

lpinca approved these changes May 4, 2017

View reviewed changes

kysnm force-pushed the change-test-option branch from c499f28 to ff3a0db Compare May 4, 2017 17:45

kysnm force-pushed the change-test-option branch from ff3a0db to 557c5c3 Compare May 4, 2017 17:46

Fix to words more better

c05c325

kysnm force-pushed the change-test-option branch from 557c5c3 to c05c325 Compare May 4, 2017 17:48

refack approved these changes May 4, 2017

View reviewed changes

aqrln reviewed May 4, 2017

View reviewed changes

Fix to plural

fd8324e

watilde approved these changes May 5, 2017

View reviewed changes

jasnell approved these changes May 5, 2017

View reviewed changes

gibfahn reviewed May 5, 2017

View reviewed changes

refack reviewed May 6, 2017

View reviewed changes

refack mentioned this pull request May 6, 2017

test, build: add test-ci wrappers #12874

Closed

3 tasks

Change the word more naturally

2d52243

addaleax approved these changes May 7, 2017

View reviewed changes

gibfahn mentioned this pull request May 8, 2017

doc, test: question about test.py -v key in CONTRIBUTING.md #12771

Closed

Add option -J

f7a15d7

gibfahn approved these changes May 11, 2017

View reviewed changes

aqrln approved these changes May 11, 2017

View reviewed changes

refack closed this May 12, 2017

kysnm deleted the change-test-option branch May 12, 2017 17:18

jasnell mentioned this pull request May 28, 2017

8.0.0 Release Proposal #12220

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

MylesBorins added the land-on-v6.x label Jun 22, 2017

MylesBorins mentioned this pull request Jul 18, 2017

v6.11.2 proposal #14356

Merged

doc: Change test option at STEP 5: Test in CONTRIBUTING.md #12830

doc: Change test option at STEP 5: Test in CONTRIBUTING.md #12830

Conversation

kysnm commented May 4, 2017 • edited Loading

Checklist

Affected core subsystem(s)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vsemozhetbyt left a comment

Choose a reason for hiding this comment

kysnm commented May 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vsemozhetbyt commented May 4, 2017

kysnm commented May 4, 2017

lpinca commented May 4, 2017

kysnm commented May 4, 2017

lpinca commented May 4, 2017

kysnm commented May 4, 2017 • edited Loading

Choose a reason for hiding this comment

aqrln May 4, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kysnm commented May 4, 2017

gibfahn May 5, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack May 6, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kysnm commented May 10, 2017 • edited Loading

gibfahn commented May 10, 2017

kysnm commented May 11, 2017 • edited Loading

kysnm commented May 11, 2017

aqrln left a comment

Choose a reason for hiding this comment

kysnm commented May 12, 2017

refack commented May 12, 2017

kysnm commented May 4, 2017 •

edited

Loading

kysnm commented May 4, 2017 •

edited

Loading

aqrln May 4, 2017 •

edited

Loading

gibfahn May 5, 2017 •

edited

Loading

refack May 6, 2017 •

edited

Loading

kysnm commented May 10, 2017 •

edited

Loading

kysnm commented May 11, 2017 •

edited

Loading