Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Add a Getting Involved guide #75

Merged
merged 8 commits into from
Jul 31, 2017
Merged

Add a Getting Involved guide #75

merged 8 commits into from
Jul 31, 2017

Conversation

bnb
Copy link
Contributor

@bnb bnb commented Jun 9, 2017

This adds a very bare-bones guide to getting involved to the Community Committee. The contents reference an Issue (#74) and a PR (#73) - that I've submitted as easy wins for things to help people get started.

This is very much a WIP, and any + all input is appreciated on how to improve. ❤️

Create the raw first draft of GETTING_INVOLVED.md
@jennwrites
Copy link
Contributor

I'm curious, how is this different from the collaborator guide? And couldn't we consolidate this info into one doc?

@bnb bnb mentioned this pull request Jun 9, 2017
@nebrius
Copy link
Contributor

nebrius commented Jun 9, 2017

I agree with @renrutnnej, this should go in CONTRIBUTING.md

@bnb
Copy link
Contributor Author

bnb commented Jun 9, 2017

@renrutnnej That is actually a problem I ran into at the beginning - I was having a hard time distinguishing between what should go in a Contributing Guide versus something that's completely introductory for newcomers.

The distinction I landed on was that the Collaborator Guide seemed to be a reference for existing collaborators (which, I just learned, is actually distinct from members #71). The goal with this was to have a starting point where we can directly point to for people who are curious about how to get involved, but aren't sure exactly how.

That could possibly fit within the scope of the Collaborator Guide as a section - would love to hear your thoughts 👍

@jennwrites
Copy link
Contributor

I’m concerned that we're putting a lot of effort into documentation and process before we’ve had solid examples to document.

My experience with onboarding new folks in the Hoodie project showed me that you want to make documentation as simple & concise as humanly possible to empower action and not let people get confused and disengage.

@nebrius
Copy link
Contributor

nebrius commented Jun 9, 2017

The distinction I landed on was that the Collaborator Guide seemed to be a reference for existing collaborators

Not really, if it comes off that way, then that's a problem in the contributing guide.

These changes definitely should go in the CONTRIBUTING.md. That file is special in GitHub land because it's what's referenced in issues and pull requests in the GitHub UI. We definitely don't want to loose that ability.

@bnb
Copy link
Contributor Author

bnb commented Jun 9, 2017

My experience with onboarding new folks in the Hoodie project showed me that you want to make documentation as simple & concise as humanly possible to empower action and not let people get confused and disengage.

Awesome feedback, @renrutnnej. 🙏

If there's a more simple way to get people onboarded, I'm 100000% for that - I really just want to be able to empower people to get started, and at this point I'm jut not quite sure how we can do that consistently and effectively. That was my goal with this - happy to take an alternative route.

mhdawson

This comment was marked as off-topic.

@mhdawson
Copy link
Member

Is it also worth mentioning that watching the recordings of the Community Committee meetings and reviewing the minutes is also a good way to get up to speed with what is being discussed ?

@ghost
Copy link

ghost commented Jun 14, 2017

@mhdawson i think that's a good idea! this shouldn't be limited to only commcomm though - it should say something like Read through meeting notes of a team that interests you or something

@bnb
Copy link
Contributor Author

bnb commented Jun 14, 2017

@mhdawson Issue right now is there's not an easy way to go find the meeting recordings. Minutes are in place, I'll likely go submit a PR to add recording URLs to the minutes.

@pup Also +1! I want to be sure we have that content before adding it though - don't want to direct people to something that doesn't exist yet 😊

Adds in the hyperlink for "Good First Contribution" in the CommComm repo.
@hackygolucky
Copy link
Contributor

hackygolucky commented Jul 6, 2017

@nebrius Are you +1 on this document now but -1 on its location? If so, will moving it to CONTRIBUTING.MD change your mind? I'm happy to approve this PR once it is moved if this is the contingency you think should be applied.

@nebrius
Copy link
Contributor

nebrius commented Jul 6, 2017

@hackygolucky not yet. Once this is moved to CONTRIBUTING.md though, I think we'll be ready to go!

bnb added 2 commits July 10, 2017 16:25
Moved the contents of `GETTING_INVOLVED.md` into `CONTRIBUTING.md`
Removes GETTING_INVOLVED.md, as contents have been moved to CONTRIBUTING.md.
@bnb
Copy link
Contributor Author

bnb commented Jul 10, 2017

@nebrius / @hackygolucky moved to CONTRIBUTING.md - didn't realize that was the blocker 😅

Please LMK if the location is good or bad - I figured "Getting Started" should go at the beginning, but can move as needed.

nebrius

This comment was marked as off-topic.

@bnb
Copy link
Contributor Author

bnb commented Jul 18, 2017

@nebrius Updated 😁

nebrius

This comment was marked as off-topic.

mhdawson

This comment was marked as off-topic.

RichardLitt

This comment was marked as off-topic.

RichardLitt

This comment was marked as off-topic.

RichardLitt

This comment was marked as off-topic.

gr2m

This comment was marked as off-topic.

Adds the missing link to teams and WGs.
@bnb
Copy link
Contributor Author

bnb commented Jul 24, 2017

@gr2m Updated that - thanks! This PR predated that being linked, and I added the placeholder so I'd go and add in a section (see #73) 😅

gr2m

This comment was marked as off-topic.

@nebrius
Copy link
Contributor

nebrius commented Jul 31, 2017

Looks like this is ready to go, thanks again @bnb! 🎉

@nebrius nebrius merged commit 4544c5f into nodejs:master Jul 31, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants