Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: restrict the ES.Next features usage in tests #11452

Closed
wants to merge 1 commit into from
Closed

doc: restrict the ES.Next features usage in tests #11452

wants to merge 1 commit into from

Conversation

DavidCai1111
Copy link
Member

@DavidCai1111 DavidCai1111 commented Feb 18, 2017 •
edited
Loading

Update the writing-tests guide 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 in all maintained branches) .

Refs: #11290

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Feb 18, 2017
@DavidCai1111
Copy link
Member Author

@mscdex @joyeecheung

@i5ting
Copy link

i5ting commented Feb 18, 2017

nice job

joyeecheung
joyeecheung reviewed Feb 18, 2017
View reviewed changes
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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member Author

@joyeecheung Updated, PTAL.

joyeecheung
joyeecheung reviewed Feb 18, 2017
View reviewed changes
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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lts project link should have a text. Maybe [the LTS page](https://github.com/nodejs/lts).

Also nit: 80-character wrap.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@joyeecheung joyeecheung Feb 18, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

@DavidCai1111 DavidCai1111 Feb 19, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, updated 👍

@joyeecheung
Copy link
Member

@Trott might want to take a look at this?

@Trott
Copy link
Member

Trott commented Feb 19, 2017

@nodejs/testing

Seems A-OK to me.

@joyeecheung
Copy link
Member

Landed in 88035bc, thanks!

joyeecheung pushed a commit that referenced this pull request Feb 21, 2017
@DavidCai1111 @joyeecheung
doc: restrict the ES.Next features usage in tests
88035bc 
PR-URL: #11452
Refs: #11290
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
addaleax pushed a commit that referenced this pull request Feb 22, 2017
@DavidCai1111 @addaleax
doc: restrict the ES.Next features usage in tests
c5ff76d 
PR-URL: #11452
Refs: #11290
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@italoacasas italoacasas mentioned this pull request Feb 25, 2017
Merged
@jasnell
Copy link
Member

jasnell commented Mar 7, 2017

this would need a backport pr to land in v6 or v4

DavidCai1111 added a commit to DavidCai1111/node that referenced this pull request Mar 7, 2017
@DavidCai1111
doc: restrict the ES.Next features usage in tests
9cce019 
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>
@DavidCai1111 DavidCai1111 mentioned this pull request Mar 7, 2017
Closed
3 tasks
@DavidCai1111
Copy link
Member Author

@jasnell Backport PR: #11725

@MylesBorins
Copy link
Contributor

@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?

@DavidCai1111
Copy link
Member Author

@MylesBorins Sure 😄

@DavidCai1111 DavidCai1111 mentioned this pull request Mar 8, 2017
Closed
3 tasks
@DavidCai1111
Copy link
Member Author

@MylesBorins PR for v6.x: #11743

MylesBorins pushed a commit that referenced this pull request Mar 9, 2017
@DavidCai1111 @MylesBorins
doc: restrict the ES.Next features usage in tests
c2e818d 
PR-URL: #11452
Refs: #11290
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 9, 2017
@DavidCai1111 @MylesBorins
doc: restrict the ES.Next features usage in tests
227cc1e 
PR-URL: #11452
Refs: #11290
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Mar 9, 2017
Merged
abhishekumar-tyagi pushed a commit to abhishekumar-tyagi/node that referenced this pull request May 5, 2024
@DavidCai1111
doc: restrict the ES.Next features usage in tests
67f563b 
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joyeecheung joyeecheung joyeecheung approved these changes

@lpinca lpinca lpinca approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@DavidCai1111 @i5ting @joyeecheung @Trott @jasnell @MylesBorins @lpinca @nodejs-github-bot