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: add Support section in README #16533

Closed
wants to merge 1 commit into
base: master
from

Conversation

@Trott
Member

Trott commented Oct 26, 2017

Add a Support section, borrowing heavily from wp-cli project.

Move stuff about contributing to Node.js to the bottom as vastly more
users are interested in using Node.js and getting help with Node.js than
contributing to Node.js. Information still belongs, just not at the top.
(Many people will know to look in CONTRIBUTING.md anyway.)

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

@Trott Trott added the doc label Oct 26, 2017

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Oct 26, 2017

Member

Ping @danielbachhuber who appears to have authored most of the similar text for wp-cli. Hopefully they can loop in anyone else from that project who might be relevant. Just in case they disagree with my assessment that the amount of borrowed text does not warrant a LICENSE mention or anything like that.

Ref: https://github.com/wp-cli/wp-cli#support

Member

Trott commented Oct 26, 2017

Ping @danielbachhuber who appears to have authored most of the similar text for wp-cli. Hopefully they can loop in anyone else from that project who might be relevant. Just in case they disagree with my assessment that the amount of borrowed text does not warrant a LICENSE mention or anything like that.

Ref: https://github.com/wp-cli/wp-cli#support

@danielbachhuber

This comment has been minimized.

Show comment
Hide comment
@danielbachhuber

danielbachhuber Oct 26, 2017

I release my WP-CLI support section contributions to the public domain.

danielbachhuber commented Oct 26, 2017

I release my WP-CLI support section contributions to the public domain.

@danielbachhuber

This comment has been minimized.

Show comment
Hide comment
@danielbachhuber

danielbachhuber Oct 26, 2017

I'm also humbled and honored that you copied my text 😄

danielbachhuber commented Oct 26, 2017

I'm also humbled and honored that you copied my text 😄

Show outdated Hide outdated README.md Outdated
Show outdated Hide outdated README.md Outdated
Show outdated Hide outdated README.md Outdated
@maclover7

+1 to "Support" vs. "Resources for Newcomers"

### Contributing to Node.js
* [Contributing to the project][]
* IRC (node core development): [#node-dev on chat.freenode.net][]

This comment has been minimized.

@maclover7

maclover7 Oct 26, 2017

Member

Worth it to ditch the IRC link and just simply say "See CONTRIBUTING.md for details", since that venue is definitely mentioned there?

@maclover7

maclover7 Oct 26, 2017

Member

Worth it to ditch the IRC link and just simply say "See CONTRIBUTING.md for details", since that venue is definitely mentioned there?

This comment has been minimized.

@refack

refack Oct 26, 2017

Member

+1 to @maclover7.
Not that the IRC is too noisy, but RTFMing before asking there will IMHO get the requester better answers.

@refack

refack Oct 26, 2017

Member

+1 to @maclover7.
Not that the IRC is too noisy, but RTFMing before asking there will IMHO get the requester better answers.

Show outdated Hide outdated README.md Outdated
@@ -577,11 +578,16 @@ Previous releases may also have been signed with one of the following GPG keys:
Information on the current Node.js Working Groups can be found in the
[TSC repository](https://github.com/nodejs/TSC/blob/master/WORKING_GROUPS.md).
### Contributing to Node.js

This comment has been minimized.

@vsemozhetbyt

vsemozhetbyt Oct 26, 2017

Member

Is it worth to add this in TOC?

@vsemozhetbyt

vsemozhetbyt Oct 26, 2017

Member

Is it worth to add this in TOC?

Show outdated Hide outdated README.md Outdated
Show outdated Hide outdated README.md Outdated
Show outdated Hide outdated README.md Outdated
@refack

refack approved these changes Oct 26, 2017

% nits

Show outdated Hide outdated README.md Outdated
Show outdated Hide outdated README.md Outdated
### Contributing to Node.js
* [Contributing to the project][]
* IRC (node core development): [#node-dev on chat.freenode.net][]

This comment has been minimized.

@refack

refack Oct 26, 2017

Member

+1 to @maclover7.
Not that the IRC is too noisy, but RTFMing before asking there will IMHO get the requester better answers.

@refack

refack Oct 26, 2017

Member

+1 to @maclover7.
Not that the IRC is too noisy, but RTFMing before asking there will IMHO get the requester better answers.

@joyeecheung

LGTM % broken link syntax

doc: add Support section in README
Add a Support section, borrowing heavily from wp-cli project.

Move stuff about contributing to Node.js to the bottom as vastly more
users are interested in using Node.js and getting help with Node.js than
contributing to Node.js. Information still belongs, just not at the top.
(Many people will know to look in CONTRIBUTING.md anyway.)

Refs: https://github.com/wp-cli/wp-cli#support
@mhdawson

LGTM

Trott added a commit to Trott/io.js that referenced this pull request Nov 17, 2017

doc: add Support section in README
Add a Support section, borrowing heavily from wp-cli project.

Move stuff about contributing to Node.js to the bottom as vastly more
users are interested in using Node.js and getting help with Node.js than
contributing to Node.js. Information still belongs, just not at the top.
(Many people will know to look in CONTRIBUTING.md anyway.)

PR-URL: nodejs#16533
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Nov 17, 2017

Member

Landed in 6b6474d.

Member

Trott commented Nov 17, 2017

Landed in 6b6474d.

@Trott Trott closed this Nov 17, 2017

Trott added a commit to Trott/io.js that referenced this pull request Nov 17, 2017

doc: remove IRC node-dev link from README
The IRC link is mentioned in CONTRIBUTING.md which is linked immediately
above. We should encourage people to read that doc before hoping on the
IRC channel.

Refs: nodejs#16533 (comment)

@Trott Trott referenced this pull request Nov 17, 2017

Closed

doc: multiple README fixes #17106

3 of 3 tasks complete

Trott added a commit to Trott/io.js that referenced this pull request Nov 17, 2017

doc: remove IRC node-dev link from README
The IRC link is mentioned in CONTRIBUTING.md which is linked immediately
above. We should encourage people to read that doc before hoping on the
IRC channel.

Refs: nodejs#16533 (comment)
@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt

vsemozhetbyt Nov 17, 2017

Member

@Trott It fails doc linter due to [Node.js Moderation Policy] unused definition in line 595.

Member

vsemozhetbyt commented Nov 17, 2017

@Trott It fails doc linter due to [Node.js Moderation Policy] unused definition in line 595.

@vsemozhetbyt vsemozhetbyt referenced this pull request Nov 17, 2017

Closed

doc: fix a link in dgram.md #17107

3 of 3 tasks complete
@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt
Member

vsemozhetbyt commented Nov 17, 2017

Fix: #17108

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Nov 17, 2017

Member

@Trott It fails doc linter due to [Node.js Moderation Policy] unused definition in line 595.

Hmmm...it passed for me...I thought...ugh, embarrassing. Sorry. Thanks for the fix.

Member

Trott commented Nov 17, 2017

@Trott It fails doc linter due to [Node.js Moderation Policy] unused definition in line 595.

Hmmm...it passed for me...I thought...ugh, embarrassing. Sorry. Thanks for the fix.

@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt

vsemozhetbyt Nov 17, 2017

Member

@Trott Could it be that you have run ESLint, but not remark-lint?

Member

vsemozhetbyt commented Nov 17, 2017

@Trott Could it be that you have run ESLint, but not remark-lint?

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Nov 17, 2017

Member

@vsemozhetbyt Yes, exactly! I did make lint-js because...that's what I do without thinking.

Member

Trott commented Nov 17, 2017

@vsemozhetbyt Yes, exactly! I did make lint-js because...that's what I do without thinking.

@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt

vsemozhetbyt Nov 17, 2017

Member

Well, we have so many linters now, it may really be confusing)

Member

vsemozhetbyt commented Nov 17, 2017

Well, we have so many linters now, it may really be confusing)

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Nov 18, 2017

Member

Well, we have so many linters now, it may really be confusing)

True, but I should have run a CI job anyway.

Member

Trott commented Nov 18, 2017

Well, we have so many linters now, it may really be confusing)

True, but I should have run a CI job anyway.

@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt
Member

vsemozhetbyt commented Nov 18, 2017

https://github.com/nodejs/node-core-utils can help with this check now)

Trott added a commit to Trott/io.js that referenced this pull request Nov 20, 2017

doc: remove IRC node-dev link from README
The IRC link is mentioned in CONTRIBUTING.md which is linked immediately
above. We should encourage people to read that doc before hoping on the
IRC channel.

PR-URL: nodejs#17106
Ref: nodejs#16533 (comment)
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

MylesBorins added a commit that referenced this pull request Dec 12, 2017

doc: add Support section in README
Add a Support section, borrowing heavily from wp-cli project.

Move stuff about contributing to Node.js to the bottom as vastly more
users are interested in using Node.js and getting help with Node.js than
contributing to Node.js. Information still belongs, just not at the top.
(Many people will know to look in CONTRIBUTING.md anyway.)

PR-URL: #16533
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

MylesBorins added a commit that referenced this pull request Dec 12, 2017

doc: remove IRC node-dev link from README
The IRC link is mentioned in CONTRIBUTING.md which is linked immediately
above. We should encourage people to read that doc before hoping on the
IRC channel.

PR-URL: #17106
Ref: #16533 (comment)
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

@MylesBorins MylesBorins referenced this pull request Dec 12, 2017

Merged

v9.3.0 proposal #17631

gibfahn added a commit that referenced this pull request Dec 19, 2017

doc: add Support section in README
Add a Support section, borrowing heavily from wp-cli project.

Move stuff about contributing to Node.js to the bottom as vastly more
users are interested in using Node.js and getting help with Node.js than
contributing to Node.js. Information still belongs, just not at the top.
(Many people will know to look in CONTRIBUTING.md anyway.)

PR-URL: #16533
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

MylesBorins added a commit that referenced this pull request Dec 19, 2017

doc: add Support section in README
Add a Support section, borrowing heavily from wp-cli project.

Move stuff about contributing to Node.js to the bottom as vastly more
users are interested in using Node.js and getting help with Node.js than
contributing to Node.js. Information still belongs, just not at the top.
(Many people will know to look in CONTRIBUTING.md anyway.)

PR-URL: #16533
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

MylesBorins added a commit that referenced this pull request Dec 19, 2017

doc: remove IRC node-dev link from README
The IRC link is mentioned in CONTRIBUTING.md which is linked immediately
above. We should encourage people to read that doc before hoping on the
IRC channel.

PR-URL: #17106
Ref: #16533 (comment)
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

gibfahn added a commit that referenced this pull request Dec 19, 2017

doc: remove IRC node-dev link from README
The IRC link is mentioned in CONTRIBUTING.md which is linked immediately
above. We should encourage people to read that doc before hoping on the
IRC channel.

PR-URL: #17106
Ref: #16533 (comment)
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

@gibfahn gibfahn referenced this pull request Dec 20, 2017

Closed

v8.9.4 proposal #17772

gibfahn added a commit that referenced this pull request Dec 20, 2017

doc: add Support section in README
Add a Support section, borrowing heavily from wp-cli project.

Move stuff about contributing to Node.js to the bottom as vastly more
users are interested in using Node.js and getting help with Node.js than
contributing to Node.js. Information still belongs, just not at the top.
(Many people will know to look in CONTRIBUTING.md anyway.)

PR-URL: #16533
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

gibfahn added a commit that referenced this pull request Dec 20, 2017

doc: remove IRC node-dev link from README
The IRC link is mentioned in CONTRIBUTING.md which is linked immediately
above. We should encourage people to read that doc before hoping on the
IRC channel.

PR-URL: #17106
Ref: #16533 (comment)
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

@gibfahn gibfahn referenced this pull request Dec 20, 2017

Merged

v8.9.4 proposal #17774

@MylesBorins MylesBorins referenced this pull request Dec 20, 2017

Merged

v6.12.3 proposal #17776

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment