Create a best practices document

[joesepi]

It seems that some best practices are being identified as development continues and we should add them to a document (not unlike you'd add to an FAQ doc) for people to understand some of the repeatable approaches used in development of the site.

Discussed with @lidoravitan in a meeting.

[lidoravitan]

Should it be part of CONTRIBUTING.md or create a new file for it?

[benhalverson]

What should go in this doc? A lot of our practices are in the .eslintrc

[marcustisater]

I think you could create new markdown pages like https://github.com/nodejs/node/tree/master/doc/guides and have them linked in the CONTRIBUTING.md so it's easy to find.

[lancemccluskey]

@benhalverson can I work on this? I like @marcustisater idea to create a /guides directory to hold markdown files containing best practices. Maybe it could even be hosted on the site at some point

[lancemccluskey]

So I created the guides directory, and im thinking it could be hosted on the site kinda like learn pages. What do yall think?

[MrSlimCoder]

@joesepi I want to jointhis organization can you please guide me.

[rodion-arr]

Hi @MRslimcoder, you can find the policy by this link - https://github.com/nodejs/nodejs.dev/blob/main/CONTRIBUTING.md#how-to-become-a-collaborator

[github-actions[bot]]

This issue is stale because it has been open for 60 days with no activity.

[github-actions[bot]]

This isseue was closed because it has been inactive for 14 days since being marked as stale.