doc: restrict the ES.Next features usage in tests #11452
Conversation
|
nice job |
doc/guides/writing-tests.md
Outdated
| tests, it is encouraged to use ES.Next features that have already landed | ||
| in the ECMAScript specification. For example: | ||
| tests, for the ease of backporting, it is encouraged to use those ES.Next | ||
| features that can be used directly [without a flag in v4.x](http://node.green). |
There was a problem hiding this comment.
May be s/v4.x/all maintained branches for timelessness. (we can add a link to https://github.com/nodejs/lts to explain what are those maintained branches)
There was a problem hiding this comment.
Also we can add a link to the upcoming backporting guide to the backporting part, doesn't need to happen in this PR though. Pending PR: #11099
DavidCai1111
force-pushed
the
doc/test
branch
from
70c8f5c
to
da955f1
Compare
|
@joyeecheung Updated, PTAL. |
doc/guides/writing-tests.md
Outdated
| tests, it is encouraged to use ES.Next features that have already landed | ||
| in the ECMAScript specification. For example: | ||
| tests, for the ease of backporting, it is encouraged to use those ES.Next | ||
| features that can be used directly without a flag in [lts/v4.x/all maintained branches](http://node.green) (See https://github.com/nodejs/lts for more information about what are those maintained branches). |
There was a problem hiding this comment.
The lts project link should have a text. Maybe [the LTS page](https://github.com/nodejs/lts).
Also nit: 80-character wrap.
There was a problem hiding this comment.
Actuallyall maintained branches is probably clear enough(no need for the lts/v4.x part). The lts link can be attached to this phrase and the node.green tip can be placed in the parens.
There was a problem hiding this comment.
Oh uh..by s/v4.x/all maintained branches/ I meant "replace v4.x with all maintained branches"(sed syntax). Sorry for not being clear.
There was a problem hiding this comment.
Thanks for the correction, so "for the ease of backporting, it is encouraged to use those ES.Next features that can be used directly without a flag in [all maintained branches](https://github.com/nodejs/lts), you can check [node.green](http://node.green) for all available features in each release." will be better?
|
@Trott might want to take a look at this? |
|
@nodejs/testing Seems A-OK to me. |
DavidCai1111
force-pushed
the
doc/test
branch
from
da955f1
to
67e933d
Compare
|
Landed in 88035bc, thanks! |
|
this would need a backport pr to land in v6 or v4 |
PR-URL: nodejs#11452 Refs: nodejs#11290 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
@DavidCai1993 I'm noticing a backport to v4.x with a conflict, but no backport to v6.x. Would you be able to do v6 too? |
|
@MylesBorins Sure 😄 |
|
@MylesBorins PR for v6.x: #11743 |
PR-URL: nodejs/node#11452 Refs: nodejs/node#11290 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Update the
writing-testsguide to restrict the ES.Next features usage in tests for the ease of backporting (only encourage to use those features that can be used directly without a flag inall maintained branches) .Refs: #11290
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc