[RFC] doc: add How to write a node test guide

[santigimeno]

It's a very basic guide on how to write a node test. It surely needs more work (and syntax corrections!) but it can be a good starting point. Comments are welcome. Thanks.

P.S.: I'm planning to create an accompanying text documenting the common API.

[cjihrig]

node -> Node.js

[santigimeno]

Updated per @cjihrig comments. Thanks!!

[cjihrig]

Can you spell out "two"

[santigimeno]

Updated! Thanks again @cjihrig !

[cjihrig]

LGTM

[jasnell]

This should also say something about things like // Flags: --expose-internals ... specifically, adding a // Flags comment in the pre-amble of the test (along with the 'use strict'; allows the test to be run with specific Node.js command line flags set. In the case of --expose-internals, it allows a test to require the various internal/* modules used internally by Node core.

[jasnell]

Perhaps something about common.platformTimeout() here?

[jasnell]

Great work @santigimeno! Great to see this. Left a few suggestions.

[Trott]

LGTM. Thank you so much for doing this, @santigimeno!

[Trott]

Bump! Is this publishable as it stands or does it need a few tweaks?

[santigimeno]

@Trott I wanted to incoporate @jasnell suggestions first, but had no time in the last few weeks :(. I think it can be publishable as it is and can improve it afterwards.
General question: where do you think this doc should live in?

[Trott]

General question: where do you think this doc should live in?

It's short enough and important/helpful enough that I would make it part of test/README.md in the main core repository. I think the README needs (at least) three things:

• How to run the tests
• How to write tests (what this doc is!)
• What the various tests are (this is what's there already, although it can use some expansion perhaps)