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

sarahmeyer
Copy link
Contributor

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.

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Dec 1, 2016
@MylesBorins
Copy link
Contributor

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

@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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.)

Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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

@addaleax addaleax added the code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. label Dec 2, 2016
@jasnell
Copy link
Member

jasnell commented Dec 16, 2016

ping @sarahmeyer :-)

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
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
Copy link
Contributor

lgtm

@Trott Trott dismissed MylesBorins’s stale review December 24, 2016 18:37

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

Trott pushed a commit to Trott/io.js that referenced this pull request Dec 24, 2016
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 <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
@Trott
Copy link
Member

Trott commented Dec 24, 2016

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

@Trott Trott closed this Dec 24, 2016
targos pushed a commit that referenced this pull request Dec 26, 2016
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 <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Dec 27, 2016
evanlucas pushed a commit that referenced this pull request Jan 3, 2017
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 <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
evanlucas pushed a commit that referenced this pull request Jan 4, 2017
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 <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jan 23, 2017
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 <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jan 24, 2017
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 <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Jan 24, 2017
MylesBorins pushed a commit that referenced this pull request Feb 1, 2017
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 <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants