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

doc: add Support section in README #16533

Closed
wants to merge 1 commit into from
Closed

doc: add Support section in README #16533

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 27 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,10 @@ policies, and releases are managed under an

**This project is bound by a [Code of Conduct][].**

If you need help using or installing Node.js, please use the
[nodejs/help](https://github.com/nodejs/help) issue tracker.


# Table of Contents

* [Resources for Newcomers](#resources-for-newcomers)
* [Support](#support)
* [Release Types](#release-types)
* [Download](#download)
* [Current and LTS Releases](#current-and-lts-releases)
Expand All @@ -39,25 +36,29 @@ If you need help using or installing Node.js, please use the
* [Collaborators](#collaborators)
* [Release Team](#release-team)

## Resources for Newcomers
## Support

Node.js contributors have limited availability to address general support
questions. Please make sure you are using a [currently-supported version of
Node.js](https://github.com/nodejs/Release#release-schedule).

### Official Resources
When looking for support, please first search for your question in these venues:

* [Website][]
* [Node.js Website][]
* [Node.js Help][]
* [Contributing to the project][]
* IRC (node core development): [#node-dev on chat.freenode.net][]
* [Open or closed issues in the Node.js GitHub organization](https://github.com/issues?utf8=%E2%9C%93&q=sort%3Aupdated-desc+org%3Anodejs+is%3Aissue)
* [Questions tagged 'node.js' on StackOverflow][]

If you didn't find an answer in one of the venues above, you can:

### Unofficial Resources
* Join the **unofficial** [#node.js channel on chat.freenode.net][]. See
<http://nodeirc.info/> for more information.

* IRC (general questions): [#node.js on chat.freenode.net][]. Please see
<http://nodeirc.info/> for more information regarding the `#node.js` IRC
channel.
GitHub issues are meant for tracking enhancements and bugs, not general support.

_Please note that unofficial resources are neither managed by (nor necessarily
endorsed by) the Node.js TSC. Specifically, such resources are not
currently covered by the [Node.js Moderation Policy][] and the selection and
actions of resource operators/moderators are not subject to TSC oversight._
Remember, libre != gratis; the open source license grants you the freedom to use
and modify, but not commitments of other people's time. Please be respectful,
and set your expectations accordingly.

## Release Types

Expand Down Expand Up @@ -582,11 +583,17 @@ 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
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it worth to add this in TOC?


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

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

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


[npm]: https://www.npmjs.com
[Website]: https://nodejs.org/en/
[Code of Conduct]: https://github.com/nodejs/TSC/blob/master/CODE_OF_CONDUCT.md
[Contributing to the project]: CONTRIBUTING.md
[Node.js Help]: https://github.com/nodejs/help
[Node.js Moderation Policy]: https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md
[#node.js on chat.freenode.net]: https://webchat.freenode.net?channels=node.js&uio=d4
[Node.js Website]: https://nodejs.org/en/
[Questions tagged 'node.js' on StackOverflow]: https://stackoverflow.com/questions/tagged/node.js
[#node.js channel on chat.freenode.net]: https://webchat.freenode.net?channels=node.js&uio=d4
[#node-dev on chat.freenode.net]: https://webchat.freenode.net?channels=node-dev&uio=d4
[Code of Conduct]: https://github.com/nodejs/TSC/blob/master/CODE_OF_CONDUCT.md