Skip to content

doc: shorten intro of README.md

Rodrigo Muino Tomonari requested to merge github/fork/Trott/passive-01 into master

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." Remove that sentence as it seems 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.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Merge request reports