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.

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

Reposition "How to Contribute" section #27811

Closed
wants to merge 3 commits into from
Closed

Conversation

anish-94
Copy link
Contributor

@anish-94 anish-94 commented May 22, 2019

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

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 22, 2019
@@ -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
Copy link
Member

Choose a reason for hiding this comment

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

Kindly move contributing to Node.js in table of contents from line 35 to line 30

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed!

@Trott
Copy link
Member

Trott commented May 22, 2019

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....

@Trott
Copy link
Member

Trott commented May 22, 2019

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.

@anish-94
Copy link
Contributor Author

@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.

@Trott
Copy link
Member

Trott commented May 25, 2019

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.

@anish-94
Copy link
Contributor Author

anish-94 commented May 25, 2019

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

That's fair. Updated!

@Trott
Copy link
Member

Trott commented May 26, 2019

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 26, 2019
@addaleax
Copy link
Member

Landed in 9b7cd2b, thanks for the PR! 🎉

@addaleax addaleax closed this May 26, 2019
addaleax pushed a commit that referenced this pull request May 26, 2019
PR-URL: #27811
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
targos pushed a commit that referenced this pull request May 28, 2019
PR-URL: #27811
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@targos targos mentioned this pull request Jun 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants