search

nodejs / inclusivity

Improving inclusivity in the node community
80 stars 22 forks source link

add CONTRIBUTING.md content #88

Closed ashleygwilliams closed 8 years ago

ashleygwilliams commented 8 years ago

this is a draft for CONTRIBUTING.md. this will be a ToC from which we link to all the things, e.g. issue structure, admissions, etc.

cc: @nebrius @sup @Trott @Charlotteis

ashleygwilliams commented 8 years ago

note #71 #85 are some of the docs this will link to

varjmes commented 8 years ago

Just to check my understanding:

I think the idea is to get people started with the WG as quickly as possible. This WG is going to have more and more docs and policies and issues. People tend to skip to the important parts of the CONTRIBUTING to get to their goal as quickly as possible, so it's a good idea to make this as quick as possible by doing the leg work for them. In terms of just making the reading process more accessible, breaking something like this up into small parts makes a guide less overwhelming and thus more likely to be read.

yeah?

ashleygwilliams commented 8 years ago

yeah that's my goal @Charlotteis -- do you think the current structure works? i don't plan on adding much more except links.

varjmes commented 8 years ago

This is really clear and now that the appropriate emojis have been added, I'd be happy to see this merged :)

ghost commented 8 years ago

LGTM! (so far at least)

beaugunderson commented 8 years ago

some minor formatting/link stuff; otherwise pretty solid :)

ghost commented 8 years ago

LGTM, merging!