Reposition "How to Contribute" section #27811
Conversation
| @@ -155,6 +155,12 @@ the file's signature. | |||
| See [BUILDING.md](BUILDING.md) for instructions on how to build Node.js from | |||
| source and a list of supported platforms. | |||
|
|
|||
| ## Contributing to Node.js | |||
There was a problem hiding this comment.
Kindly move contributing to Node.js in table of contents from line 35 to line 30
|
Welcome @anish-94, and thanks for the pull request! I don't oppose this change but I can't endorse it either. Someone might decide next week that the Security section needs to go above the Contributing section on that grounds that security reporting needs to be more prominent. And then someone might move the Contributing section again the next week. And so on.... |
|
One thing I could endorse (but others might oppose so who knows if it's worth PR'ing?) is moving some or all of the Collaborator/TSC/Emeriti lists out to separate files. That would make the Contributing section more prominent by at least making it less of a long scroll to get to. Another option might be to make the lists collapsed/expandable, but that probably will depend on GitHub-specific markdown, which we may want to avoid. |
|
@Trott I completely understand your point about people constantly repositioning different sections. Avoiding scrolling through ~400 lines of Collaborators/TSC/Emeriti lists just to get to the Contribution section was one of the motivations for this PR. |
Maybe move it above the list of people but keep it below security? That doesn't raise any questions about relative importance between it and security (since it leaves the ordering the same as it is now). The case that it's more important than the list of people is solid IMO. The README should serve the reader and seeing a list of 16 TSC Emeriti is not what they're looking at the file for. |
That's fair. Updated! |
Trott
added
the
author ready
|
Landed in 9b7cd2b, thanks for the PR! 🎉 |
PR-URL: #27811 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
PR-URL: #27811 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
doc: reposition "How to Contribute" section
Moving this section makes it easier to jump to contributing rather than scrolling to a larger list of information where this section is stashed away.
Checklist