Skip to content
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

Initial document for contributors #1

Merged
merged 3 commits into from
Nov 6, 2015
Merged

Initial document for contributors #1

merged 3 commits into from
Nov 6, 2015

Conversation

orta
Copy link
Member

@orta orta commented Nov 3, 2015

Happy to take feedback here, or direct pushes to this branch.

I want to try and figure out what the best practices are here, and try to formalize it. This means I can write in other OSS projects, "Conforms to the Moya Contributor Contract" or something similar. We spent quite a bit of time trying to figure out how to make others feel welcome, and it's been hashed out publicly in issues in the Moya repo.

Issues worth bringing up

Moya/Moya#135
Moya/Moya#270
Moya/Moya#168

Stuff to include?

  • Mention the CoC?
  • Good first step
  • are milestones worth talking about?
  • comments like "Should be a good one for someone to review if they've never merged a PR before /cc @Moya/contributors"
  • note the lack of an official chat, all discussion happens in issues ideally?

If you can think of times when we've done a good job here ( or dropped the ball ( it took us a while to get carthage support done right for example ) - I'd love indirect feedback in here too so we can try figure out what this looks like.

@orta
Copy link
Member Author

orta commented Nov 3, 2015

Feedback wanted, and appreciated from anyone in the org 👯

@esttorhe
Copy link
Member

esttorhe commented Nov 3, 2015

TBH I didn't know about the «push access» until after i got it and read something related from Ash on another issue.

Milestones to me seems like something useful.

Regarding the lack of an official chat its kind of a 50/50 thing; i like containing all talks regarding an issue within the same issue but is also hard to reach out to other Moya contributors when there's no issue at all at the moment.

All in all I think mentioning the CoC and the push access is something that should definitely be in the text.

Also given that we don't have a way to automatically enforce coding conventions maybe mention that somewhere in the text to avoid rejecting PRs because of this or avoid adding extra work to the contributors that are going to review/merge said PRs?


##### Background

Moya started out as a project in Artsy under the ownership of [Ash Furrow](/ashfurrow) and [Orta Therox](/orta). Over time Moya became too big for us to maintain within the Artsy product cycle.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get that you're referencing that it's an organization now, but it sounds kind of like Moya is this monster that grew outside of our control.

Maybe instead, it could be:

Over time, developers from the community began using Moya and it is now a community-driven project.

@ashfurrow
Copy link
Member

Awesome, great first-stab Orta.

CoC/Good first step definitely worth discussing. I also like the idea of encouraging comments inviting people to contribute if they're able.

Lack of official discussion is tough. I don't think we should have one, but not having one does make it difficult to contact us privately about a community problem. We could offer my email address as a confidential way to contact Moya organizers.

I think it's important to describe to how we do run the org today, and not how we'd like to run it, so I wouldn't mention milestones. (If we want to start using them, we should open an issue and discuss it, though!)

Finally, I think we should describe how PRs are merged. It's usually been a "ok, someone else said this looks good, so I'll merge" thing, so maybe codify that you should review and merge others' PRs, but your own PRs need to be reviewed by someone else. Does that make sense?

@esttorhe
Copy link
Member

esttorhe commented Nov 3, 2015

The PRs thing makes sense and i think is needed in there.

Giving your email address not so much; at some point it might generate too much traffic for a single person(?)

@orta
Copy link
Member Author

orta commented Nov 3, 2015

I think it's important to describe to how we do run the org today, and not how we'd like to run it, so I wouldn't mention milestones

We are using milestones right now though, https://github.com/Moya/Moya/milestones - as a way of stating "this is on the general todo" vs this is on our long-term thoughts

@gregpardo
Copy link

Looks like a good idea and think Orta covered the basics.

@orta
Copy link
Member Author

orta commented Nov 4, 2015

Got a bit further 👍

@orta
Copy link
Member Author

orta commented Nov 4, 2015

Alright I'm at a 🏁 point for this PR, happy to leave it open to get a few more eyes before shipping. Open for opinions etc.

@JRHeaton
Copy link

JRHeaton commented Nov 4, 2015

I really dig this 🙂. I'm a new contributor (and new to contributing to non-personal OSS projects in general), and everything here makes me feel openly invited to contribute, and aware of what I can/can't/should/shouldn't do. Nice work.

@esttorhe
Copy link
Member

esttorhe commented Nov 4, 2015

Looks good. If it helps i do have my 📧 public on my :octocat: profile in case there's a need to contact someone else.

@pmairoldi
Copy link
Member

Looks good. Sounds inviting and covers the questions I would have as a new contributor.

@ashfurrow
Copy link
Member

Cool. Anyone wanna hit the big button?

@esttorhe
Copy link
Member

esttorhe commented Nov 6, 2015

Tried but can't find the button on my iPhone not even with desktop version

@esttorhe
Copy link
Member

esttorhe commented Nov 6, 2015

Just found out I don't have write access to the repo 😅

@ashfurrow
Copy link
Member

10-4, we had a misconfigured GH org. Wanna retry?

esttorhe added a commit that referenced this pull request Nov 6, 2015
Initial document for contributors
@esttorhe esttorhe merged commit 6714800 into master Nov 6, 2015
@esttorhe
Copy link
Member

esttorhe commented Nov 6, 2015

💥

@esttorhe esttorhe deleted the init branch November 6, 2015 03:36
@pmairoldi
Copy link
Member

🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants