Nodejs.dev: Update CONTRIBUTING

[saulonunesdev]

Documentation Is

• [x] Missing/Needed
• [ ] Incorrect
• [ ] Confusing
• [ ] Not Sure?

Please Explain in Detail

In Order to prevent merge bugs and errors into master, we must update our process and align the @nodejs/nodejs-dev and @nodejs/tsc Teams.

735

718

Your Proposal for Changes

Add the following instructions in Landing Pull Requests Section

• Ping @nodejs/tsc / @MylesBorins
• Wait for +1 from @nodejs/tsc / @MylesBorins
• Do Not Merge on Weekends

[MylesBorins]

We definitely don't need to get TSC or my own approval to move things forward.

Will come up with an alternative proposal when I'm back in office tomorrow

[saulonunesdev]

764 Team Meeting Agreed to Add a Comment in the Contributing Landing PR Section, to not Merge on Weekends.

[MylesBorins]

@saulonunesdev and @nodejs/website-redesign

two thoughts.

1) Not landing on weekends does not fix the problem that we ran into and is likely to be more process than neccessary imho
2) Until this point governance for the management of the nodejs.dev repo had not been decided in meetings. It would imho be much better to open a PR with suggested changes and discuss them in the PR, only opting to go to a meeting to discuss / approve if there cannot be async consensus reached.

[bnb]

+1 to what @MylesBorins said.

[saulonunesdev]

I would suggest in this case:

• There must be no objections after a 72 hour period

[MylesBorins]

FWIW node.js core is in the process of trying to remove the waiting period altogether

https://github.com/nodejs/node/pull/33879

I'd review that thread to see reasoning why, but I am not convinced that extending the waiting period will actively help with this. The problem that we dealt with was objections not being respected... a time box is not going to avoid that situation.

[marcustisater]

Sorry for jumping in! 😅

What do you think of splitting CONTRIBUTING.md into more detailed files like get-started.md, contributing-content.md, code-guidelines.md, design.md into one doc folder?

This could also make README.md shorter to read if moved content to other .md files

[MylesBorins]

@marcustisater I think it definitely could be good to split it up

Over in Node.js core we have

• CONTRIBUTING.md index of topics that are in the guides section
• GOVERNANCE.md explicit rules about how the project is governed
• A bunch of guides for more specific information including a collaborator guide https://github.com/nodejs/node/tree/master/doc/guides

So splitting up this content into a bunch of other files is totally reasonable, but I would want to see us keep a top level GOVERNANCE.md that explicitly outlines contribution policy / rule and a top level CONTRIBUTING.md that serves as a high level index for the various guides we write.

[marcustisater]

@MylesBorins Sweet, thanks for the information. Do you mind if I try giving it a shot and we can go from there?

[designMoreWeb]

@marcustisater You can give it a go

[marcustisater]

Totally fine to scrap it if not needed. Just happy and eager to help out!

Edited: I gave this a honest try but it is more difficult than I thought. Sorry! I do however think Myles idea is the way to go, like node.js core doc directory

[benhalverson]

@marcustisater what issues did you run into?

[marcustisater]

@benhalverson it's difficult for me to define guidelines and write ones being new to the project. I think it goes along with #853

[jemjam]

Couple of notes from the meeting today:

• Just working through some confusion around the /preview and who and how can trigger it.
• Contributing could have a note at end of getting started.
• Storybook: how to see, what to use to run it. `(/storybook path)
• Folks should make pr's and we can chat over code.