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.

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

doc: Update CONTRIBUTING.MD to link to V8 guide #10070

Closed
wants to merge 1 commit into from

Conversation

Projects
None yet
7 participants
@sarahmeyer
Copy link
Contributor

sarahmeyer commented Dec 1, 2016

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

Currently, two of the guides in the /doc/guides directory are actually guides for working on the Node project. Of those, one is linked from this page. This change adds a note to point people to the other.

@MylesBorins

This comment has been minimized.

Copy link
Member

MylesBorins commented Dec 1, 2016

nit: can you add the subsystem to the commit message. doc: Update CONTRIBUTING.MD to link to V8 guide

CONTRIBUTING.md Outdated
@@ -15,6 +15,10 @@ Node.js software.
For general help using Node.js, please file an issue at the
[Node.js help repository](https://github.com/nodejs/help/issues).

For help working with the vendored version of V8 included in Node's dependency

This comment has been minimized.

Copy link
@MylesBorins

MylesBorins Dec 1, 2016

Member

This guide is specifically about how to properly update V8. I think the language here should be specific about that

This comment has been minimized.

Copy link
@Trott

Trott Dec 8, 2016

Member

Very tiny nit, but when referring to the project, it's Node.js and not Node. (And when referring to the executable, it's node and not Node.)

This comment has been minimized.

Copy link
@Trott

Trott Dec 22, 2016

Member

@thealphanerd Do you have a recommendation as to what exactly the text perhaps should be?

This comment has been minimized.

Copy link
@MylesBorins

MylesBorins Dec 22, 2016

Member

for instructions on updating the version of V8 included in node's dependency directory...

This comment has been minimized.

Copy link
@Trott

Trott Dec 23, 2016

Member

@sarahmeyer Does the text suggested by @thealphanerd seem correct and otherwise effective to you? If so, would you be willing to update this PR to use it or some variation on it?

@jasnell

This comment has been minimized.

Copy link
Member

jasnell commented Dec 16, 2016

ping @sarahmeyer :-)

Update CONTRIBUTING.MD to link to V8 guide
Currently, two of the guides in the `/doc/guides` directory are actually guides for working on the Node project. Of those, one is linked from this page. This change adds a note to point people to the other.

@Trott Trott force-pushed the sarahmeyer:patch-1 branch to 36c2617 Dec 24, 2016

@Trott

This comment has been minimized.

Copy link
Member

Trott commented Dec 24, 2016

In the interest of getting this small-but-meaningful change through the process, I updated the text myself and included a few other minor fixes to some surrounding text in the doc.

@sarahmeyer Hope that was OK for me to do!

@thealphanerd, LGTY?

@MylesBorins

This comment has been minimized.

Copy link
Member

MylesBorins commented Dec 24, 2016

lgtm

Contributor indicated 'lgtm' in subsequent comment after changes were made to address the issues raised in the review.

@targos

targos approved these changes Dec 24, 2016

Trott added a commit to Trott/io.js that referenced this pull request Dec 24, 2016

doc: update CONTRIBUTING.MD with link to V8 guide
Currently, two of the guides in the `/doc/guides` directory are actually
guides for working on the Nodei.js project. Of those, one is linked from
this page. This change adds a note to point people to the other.

PR-URL: nodejs#10070
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@Trott

This comment has been minimized.

Copy link
Member

Trott commented Dec 24, 2016

Landed in c732bd1.
Thanks for the contribution, @sarahmeyer! 🎉

@Trott Trott closed this Dec 24, 2016

targos added a commit that referenced this pull request Dec 26, 2016

doc: update CONTRIBUTING.MD with link to V8 guide
Currently, two of the guides in the `/doc/guides` directory are actually
guides for working on the Nodei.js project. Of those, one is linked from
this page. This change adds a note to point people to the other.

PR-URL: #10070
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>

@MylesBorins MylesBorins referenced this pull request Dec 27, 2016

Merged

V6.9.3 proposal #10394

@evanlucas evanlucas referenced this pull request Jan 3, 2017

Merged

v7.4.0 release proposal #10589

evanlucas added a commit that referenced this pull request Jan 3, 2017

doc: update CONTRIBUTING.MD with link to V8 guide
Currently, two of the guides in the `/doc/guides` directory are actually
guides for working on the Nodei.js project. Of those, one is linked from
this page. This change adds a note to point people to the other.

PR-URL: #10070
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>

evanlucas added a commit that referenced this pull request Jan 4, 2017

doc: update CONTRIBUTING.MD with link to V8 guide
Currently, two of the guides in the `/doc/guides` directory are actually
guides for working on the Nodei.js project. Of those, one is linked from
this page. This change adds a note to point people to the other.

PR-URL: #10070
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>

MylesBorins added a commit that referenced this pull request Jan 23, 2017

doc: update CONTRIBUTING.MD with link to V8 guide
Currently, two of the guides in the `/doc/guides` directory are actually
guides for working on the Nodei.js project. Of those, one is linked from
this page. This change adds a note to point people to the other.

PR-URL: #10070
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>

MylesBorins added a commit that referenced this pull request Jan 24, 2017

doc: update CONTRIBUTING.MD with link to V8 guide
Currently, two of the guides in the `/doc/guides` directory are actually
guides for working on the Nodei.js project. Of those, one is linked from
this page. This change adds a note to point people to the other.

PR-URL: #10070
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>

@MylesBorins MylesBorins referenced this pull request Jan 24, 2017

Merged

v4.8.0 proposal #10973

MylesBorins added a commit that referenced this pull request Feb 1, 2017

doc: update CONTRIBUTING.MD with link to V8 guide
Currently, two of the guides in the `/doc/guides` directory are actually
guides for working on the Nodei.js project. Of those, one is linked from
this page. This change adds a note to point people to the other.

PR-URL: #10070
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.