8000 doc: add Support section in README · nodejs/node@f67c0bf · GitHub
[go: up one dir, main page]
Skip to content

Commit f67c0bf

Browse files
Trottgibfahn
Trott
authored and
gibfahn
committed
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>
1 parent 97d9be5 commit f67c0bf

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

‎README.md‎

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,10 @@ policies, and releases are managed under an
1919

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

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

2623
# Table of Contents
2724

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

42-
## Resources for Newcomers
39+
## Support
40+
41+
Node.js contributors have limited availability to address general support
42+
questions. Please make sure you are using a [currently-supported version of
43+
Node.js](https://github.com/nodejs/Release#release-schedule).
4344

44-
### Official Resources
45+
When looking for support, please first search for your question in these venues:
4546

46-
* [Website][]
47+
* [Node.js Website][]
4748
* [Node.js Help][]
48-
* [Contributing to the project][]
49-
* IRC (node core development): [#node-dev on chat.freenode.net][]
49+
* [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)
50+
* [Questions tagged 'node.js' on StackOverflow][]
51+
52+
If you didn't find an answer in one of the venues above, you can:
5053

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

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

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

6263
## Release Types
6364

@@ -582,11 +583,17 @@ Previous releases may also have been signed with one of the following GPG keys:
582583
Information on the current Node.js Working Groups can be found in the
583584
[TSC repository](https://github.com/nodejs/TSC/blob/master/WORKING_GROUPS.md).
584585

586+
### Contributing to Node.js
587+
588+
* [Contributing to the project][]
589+
* IRC (node core development): [#node-dev on chat.freenode.net][]
590+
585591
[npm]: https://www.npmjs.com
586-
[Website]: https://nodejs.org/en/
592+
[Code of Conduct]: https://github.com/nodejs/TSC/blob/master/CODE_OF_CONDUCT.md
587593
[Contributing to the project]: CONTRIBUTING.md
588594
[Node.js Help]: https://github.com/nodejs/help
589595
[Node.js Moderation Policy]: https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md
590-
[#node.js on chat.freenode.net]: https://webchat.freenode.net?channels=node.js&uio=d4
596+
[Node.js Website]: https://nodejs.org/en/
597+
[Questions tagged 'node.js' on StackOverflow]: https://stackoverflow.com/questions/tagged/node.js
598+
[#node.js channel on chat.freenode.net]: https://webchat.freenode.net?channels=node.js&uio=d4
591599
[#node-dev on chat.freenode.net]: https://webchat.freenode.net?channels=node-dev&uio=d4
592-
[Code of Conduct]: https://github.com/nodejs/TSC/blob/master/CODE_OF_CONDUCT.md

0 commit comments

Comments
 (0)
0