[v2] Initial stab a separating into a Community Continuity Guidelines #7

orta · 2016-06-09T02:47:27Z

Fixes #6

OK, so, long time coming - thanks @paulofaria for our conversations recently.

This splits out the README into the "moya/contributors README" and the Community.md file. The idea being that the README shows you how to get up and running, the Community.md is what you take into your own project and modify to your specifics.

I'll be running through this for Danger, and the CocoaPods app ( both of which have different approaches to how this can be tackled ) before I can start to expand it further

@ashfurrow I want you to run through this for Moya/Moya - it's an oddity, but I think it makes sense. Plus having someone else run through the process will be helpful.

I think I'd advocate for renaming this repo to community-continuity too once this is merged and we've settled on what v2 is.

/cc @dbgrandi @ashfurrow @paulofaria @KrauseFx @segiddins @AliSoftware - would love feedback

What I'd like is focus on the new Community.md which should feel reasonable in any project's repo.

alloy · 2016-06-09T11:46:22Z

Community.md

+
+If you get a merged PR, regardless of content (typos, code, doc fixes) then you're eligible for push access to this organization. We check for this on PR merges and extend an invite via GitHub.
+
+Offhand, it's easy to imagine that this would make code quality suffer, but in reality it offers fresh perspectives to the codebase and encourages ownership from people who are depending on the project. If you are working with a codebase, then you probably have the skills to improve it, and offer valuable feedback.


That last comma reads weird to me.

I like "offhand" to describe this reaction; it's a common refrain we hear and using this phrasing frames it in a way that suggests its a reasonable feeling, even if the concern is unwarranted. I think it will help convince those on-the-fence to try this method of doing things.

AliSoftware · 2016-06-09T12:19:28Z

Side question, is there a way to automate the fact that a contributor is automatically given push access when the PR is merged?

It would also be cool to have a message to be automatically sent to thank them and explain that we granted them push access and what this means for them (e.g. no special expectation from them to give more time on the project — I've seen people refusing the push access because their thought I expected them to be the next co-maintainer or something) + a link to the Community.md. That would probably be better achieved with the new "Saved Reply" feature of GitHub (rather than making a bot post that message for us) because a bot is less personal and posting that ourselves is more welcoming and would feel less robotic, but would still be nice to have a template for this kind of canned response, right?

dbgrandi · 2016-06-09T13:03:37Z

Community.md

@@ -0,0 +1,47 @@
+# Community Continuity Guidelines v2.0.0
+
+As the creators, and maintainers of this project. We want to ensure that the project lives and continues to grow. Not blocked by any singular person's computer time.


As the creators and maintainers of this project, we want to ...

You could also change the second . to a , if you are okay with a 28 word sentence.

orta · 2016-06-09T13:56:51Z

Side question, is there a way to automate the fact that a contributor is automatically given push access when the PR is merged?

Danger as a web service could pull this off, for now the best option is to have checks like we have in Danger herself.

Agreed, we should provide advice on both using the Danger org check and a template for saved replies.

ashfurrow · 2016-06-09T13:58:34Z

README.md


-If it feels right, merge. Moya is not continuously deployed, there is space for debate after too. Offering the chance to revert, or make an amending pull request.
+- [ ] Copy the Changelog.md into your repo


Nice use of Markdown formatting, was initially confused 😄

There is no CHANGELOG.md in https://github.com/Moya/contributors/tree/v2 … so which file am I supposed to copy? 😆

Didn't you mean Community.md? (and/or README.md & Code of Conduct.md?)

orta · 2016-06-09T13:59:02Z

Everyone, thanks, I've agreed with all feedback, and made changes accordingly.

@dbgrandi - for now, I'm ok with it being GitHub specific (much as it pains me) there's a lot of GH specific terminology in here ( issues/ PR/ orgs) that could be cleaned up in another version at some point.

For now it might make it more abstract and harder to grok overall.

@AliSoftware would linking to this section help now? https://github.com/Moya/contributors/blob/v2/Community.md#our-expectations-on-you-as-a-contributor

ashfurrow · 2016-06-09T14:00:23Z

The Contributor Covenant guidelines have an "attribution" note at the bottom linking back to them, making it easier for others to follow suit. Do you think having something similar pointing to this repo in Community.md makes sense?

orta · 2016-06-09T14:18:31Z

Do you think having something similar pointing to this repo in Community.md makes sense?

Yes

AliSoftware · 2016-06-09T17:19:58Z

@AliSoftware would linking to this section help now? > https://github.com/Moya/contributors/blob/v2/Community.md#our-expectations-on-you-as-a-contributor

Indeed 👍

AliSoftware · 2016-06-09T17:31:57Z

Any reason why the file is not called Contributing.md?

I mean, I like that it's spelled lowercase instead of shouting-at-you-case 👍 but still as the common standard in OSS platforms like GitHub is to call the file serving exactly for this purpose (of explaining how it works for contributors) CONTRIBUTING.md, even if we prefer lowercase. At least keeping the name would help discoverability of that file/documentation, right?

orta · 2016-06-10T12:33:56Z

I think contributing.md has a different scope, as it's aimed at people writing issues and minutae for getting things working

https://github.com/CocoaPods/CocoaPods/blob/master/CONTRIBUTING.md
https://github.com/realm/jazzy/blob/master/CONTRIBUTING.md
https://github.com/rails/rails/blob/master/CONTRIBUTING.md#how-to-contribute-to-ruby-on-rails
https://github.com/sinatra/sinatra/blob/master/CONTRIBUTING.md
https://github.com/npm/npm/blob/master/CONTRIBUTING.md

whereas this is more about explaining how you're going to encourage people to stay

orta · 2016-06-12T17:36:00Z

Given this a third run through, think it's pretty good to go.

ashfurrow · 2016-06-12T17:46:50Z

Will run through this one last time, apply to Moya, and report back.

ashfurrow · 2016-06-17T14:54:14Z

Got some time this afternoon, gonna prioritize this.

ashfurrow · 2016-06-17T17:32:41Z

README.md


-All code is peer-reviewed, and we have the convention that someone other than the submitter should merge the pull request.
+- [ ] Copy the Changelog.md into your repo


Changelog.md should be Community.md?

ashfurrow · 2016-06-17T17:34:35Z

Community.md

+#### What about if you have problems that cannot be discussed in a public issue?
+
+[ This is an example version, please delete this and replace with your own version ]
+Both [Ash Furrow](https://github.com/ashfurrow) and [Orta Therox](https://github.com/orta) have contactable emails on their GitHub profiles, and are happy to talk about any problems.


I think replacing the names/emails with placeholders might make it more clear what needs to be replaced.

ashfurrow · 2016-06-17T17:39:23Z

I feel like maybe the adoption steps should discuss how to reference the document from the readme and in conversations.

orta · 2016-06-21T18:42:13Z

Could get some ideas from jekyll/jekyll#5011 too

ashfurrow · 2016-07-01T21:48:09Z

Community.md

@@ -45,8 +45,8 @@ If someone submits a pull request that's not perfect, and you are reviewing, it'
 #### What about if you have problems that cannot be discussed in a public issue?

 [ This is an example version, please delete this and replace with your own version ]
-Both [Ash Furrow](https://github.com/ashfurrow) and [Orta Therox](https://github.com/orta) have contactable emails on their GitHub profiles, and are happy to talk about any problems.
+Both [Jane Bloggs](https://github.com/jane_b) and [Taylor Webb](https://github.com/twebb) have contactable emails on their GitHub profiles, and are happy to talk about any problems.


Is this intentional?

Yeah, generic names, all links go no-where

orta · 2016-07-04T01:50:21Z

Alright, I'm calling this 👍

💇

[v2] Initial stab a separating into a Community Continuity Guidelines

9fd1ef4

alloy reviewed Jun 9, 2016
View reviewed changes

dbgrandi reviewed Jun 9, 2016
View reviewed changes

orta added 2 commits June 9, 2016 09:48

Revert COC changes

8323919

Improvements to community.md based on #7 feedback

aa5c553

ashfurrow reviewed Jun 9, 2016
View reviewed changes

AliSoftware mentioned this pull request Jun 9, 2016

Add CONTRIBUTING.md SwiftGen/SwiftGen#135

Closed

PR -> pull request, pass more proselint linters

dd5e421

ashfurrow reviewed Jun 17, 2016
View reviewed changes

ashfurrow mentioned this pull request Jun 17, 2016

New Community Guidelines Moya/Moya#512

Merged

1 task

orta added 2 commits June 27, 2016 10:51

More feedback

e10e6cd

Add some more links to the README

6113412

ashfurrow reviewed Jul 1, 2016
View reviewed changes

orta merged commit 10fc6b2 into master Jul 4, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[v2] Initial stab a separating into a Community Continuity Guidelines #7

[v2] Initial stab a separating into a Community Continuity Guidelines #7

orta commented Jun 9, 2016 •

edited

alloy Jun 9, 2016

ashfurrow Jun 9, 2016

AliSoftware commented Jun 9, 2016

dbgrandi Jun 9, 2016

orta commented Jun 9, 2016

ashfurrow Jun 9, 2016

AliSoftware Jun 9, 2016 •

edited

orta commented Jun 9, 2016

ashfurrow commented Jun 9, 2016

orta commented Jun 9, 2016

AliSoftware commented Jun 9, 2016

AliSoftware commented Jun 9, 2016

orta commented Jun 10, 2016 •

edited

orta commented Jun 12, 2016

ashfurrow commented Jun 12, 2016

ashfurrow commented Jun 17, 2016

ashfurrow Jun 17, 2016

ashfurrow Jun 17, 2016

ashfurrow commented Jun 17, 2016

orta commented Jun 21, 2016

ashfurrow Jul 1, 2016

orta Jul 4, 2016

orta commented Jul 4, 2016


		If you get a merged PR, regardless of content (typos, code, doc fixes) then you're eligible for push access to this organization. We check for this on PR merges and extend an invite via GitHub.

		Offhand, it's easy to imagine that this would make code quality suffer, but in reality it offers fresh perspectives to the codebase and encourages ownership from people who are depending on the project. If you are working with a codebase, then you probably have the skills to improve it, and offer valuable feedback.

		@@ -0,0 +1,47 @@
		# Community Continuity Guidelines v2.0.0

		As the creators, and maintainers of this project. We want to ensure that the project lives and continues to grow. Not blocked by any singular person's computer time.


		If it feels right, merge. Moya is not continuously deployed, there is space for debate after too. Offering the chance to revert, or make an amending pull request.
		- [ ] Copy the Changelog.md into your repo


		All code is peer-reviewed, and we have the convention that someone other than the submitter should merge the pull request.
		- [ ] Copy the Changelog.md into your repo

[v2] Initial stab a separating into a Community Continuity Guidelines #7

[v2] Initial stab a separating into a Community Continuity Guidelines #7

Conversation

orta commented Jun 9, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AliSoftware commented Jun 9, 2016

Choose a reason for hiding this comment

orta commented Jun 9, 2016

Choose a reason for hiding this comment

AliSoftware Jun 9, 2016 • edited

Choose a reason for hiding this comment

orta commented Jun 9, 2016

ashfurrow commented Jun 9, 2016

orta commented Jun 9, 2016

AliSoftware commented Jun 9, 2016

AliSoftware commented Jun 9, 2016

orta commented Jun 10, 2016 • edited

orta commented Jun 12, 2016

ashfurrow commented Jun 12, 2016

ashfurrow commented Jun 17, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashfurrow commented Jun 17, 2016

orta commented Jun 21, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orta commented Jul 4, 2016

orta commented Jun 9, 2016 •

edited

AliSoftware Jun 9, 2016 •

edited

orta commented Jun 10, 2016 •

edited