-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
doc: split COLLABORATOR_GUIDE.md #19466
Conversation
I understand why we did this for For
What are the upsides that outweigh these downsides? Thanks for doing this, by the way. Anything that tries to improve this document is appreciated. I'm not opposed to this. I would love to be persuaded to be all for it, though. |
@Trott As a contributor, I've contributed to node core in two bursts before and after the split of About the downsides:
In my work projects, we usually simplify the documentation with minimal specific instructions and use top-down approach while revisiting any documentation. This way we get to know if anything has changed in those steps, and can catch issue - if any - when the steps have been updated.
As discussed in the first downside, this is a problem while browsing the documentation on the web.
I agree that this is also a downside, but the individual files in |
I agree with @Trott in particular with this point
I often find myself juggling between the documents searching for the right one. I prefer to have all information in one place. I don't care if the document is huge, if it is well structured, it is not a problem. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The collaborator guide has an index at the top with pretty good structure. Creating more files doesn't do anything to bringing additional order to this document and it's more than likely to result in new collaborators only selectively reading what they consider relevant (whereas everyone should read the full document at least once).
Closing this issue as there are enough points supporting not going ahead with this split. |
I was going through COLLABORATOR_GUIDE.md as part of my onboarding as a NodeJS Collaborator (#19067)
Noticed that with 783 lines it's pretty long to read and can be split.
I followed PR of @joyeecheung which had split CONTRIBUTING.md in #18271 as a reference
The edits in COLLABORATOR_GUIDE.md in this PR can be viewed in my private branch at https://github.com/trivikr/node/blob/split-collab-guide/COLLABORATOR_GUIDE.md
cc @nodejs/documentation
Checklist
Affected core subsystem(s)
doc