Skip to content

Commit 6943fa9

Browse files
Trotttargos
authored andcommitted
doc: shorten intro of README.md
There are many things I might want to know about if I'm reading the introduction of the README file for Node.js: Where to get help, what the latest release is, how to compile from source, where to report bugs, how to contribute... One thing I cannot imagine wondering about is, "I wonder if there is a foundation that supports Node.js." Move that sentence to the end of the paragraph as it is designed to serve the project and not the end user. Bonus: This removes a usage of passive voice. The Linux kernel README does not mention the Linux Foundation. https://github.com/torvalds/linux/blob/master/README The jQuery README does not mention the JS Foundation. https://github.com/jquery/jquery/blob/master/README.md (It does mention the no-longer-extant jQuery Foundation but only because the Foundation itself apparently had coding standards.) The Python README only mentions the Python Software Foundation as the copyright owner. The Apache httpd README does mention the Apache Software Foundation although it does not link to it and it is mentioned in passing rather than being the topic of a declarative sentence. PR-URL: #23073 Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Refael Ackermann <[email protected]>
1 parent 085de6f commit 6943fa9

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,11 @@
99
</p>
1010

1111
Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. For
12-
more information on using Node.js, see the
13-
[Node.js Website][].
12+
more information on using Node.js, see the [Node.js Website][].
1413

15-
The Node.js project is supported by the
16-
[Node.js Foundation](https://nodejs.org/en/foundation/). Contributions,
17-
policies, and releases are managed under an
18-
[open governance model](./GOVERNANCE.md).
14+
Node.js contributions, policies, and releases are managed under an
15+
[open governance model](./GOVERNANCE.md). The [Node.js Foundation][] provides
16+
support for the project.
1917

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

@@ -643,6 +641,7 @@ Previous releases may also have been signed with one of the following GPG keys:
643641
[Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md
644642
[Contributing to the project]: CONTRIBUTING.md
645643
[Node.js Help]: https://github.com/nodejs/help
644+
[Node.js Foundation]: https://nodejs.org/en/foundation/
646645
[Node.js Website]: https://nodejs.org/en/
647646
[Questions tagged 'node.js' on StackOverflow]: https://stackoverflow.com/questions/tagged/node.js
648647
[Working Groups]: https://github.com/nodejs/TSC/blob/master/WORKING_GROUPS.md

0 commit comments

Comments
 (0)