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

added contributor code of conduct, and contribution guidelines #344

Merged
merged 3 commits into from
Jan 15, 2016

Conversation

bcoe
Copy link
Member

@bcoe bcoe commented Jan 11, 2016

  • added a contributor code of conduct, care of http://contributor-covenant.org/
  • added a brief list of instructions to help folks get started with contributions.

@bcoe
Copy link
Member Author

bcoe commented Jan 12, 2016

@nexdrew @lrlna @maxrimue how do folks feel about these contribution guidelines?

@maxrimue
Copy link
Member

Looks very good 👍

@nexdrew
Copy link
Member

nexdrew commented Jan 12, 2016

LGTM 👍

I was thinking it might be useful to have a test that checks for an email address in the doc, but it probably won't change and might be overkill.

I don't wanna get too crazy here, but do you think it makes sense to create an email address we can use as a distribution list for all interested project maintainers? There are at least 2 places now that we could use this (and it might come in handy for other places too):

  • The yargs org in GitHub
  • The code of conduct

Anyway, just a thought. It need not block this pull. I vote :shipit:

@lrlna
Copy link
Member

lrlna commented Jan 12, 2016

👍 for code of conduct part
👍 for contributing guidelines

I am thinking though, would it be useful to have something explaining how to contribute? Or most of the contributors know what they are doing? My most fahttps://github.com/npm/docs/blob/master/CONTRIBUTING.md#contributvourite example is the little to-do list on npm docs. The first couple of times I've had to contribute anywhere I basically looked back at it. But again, might not be useful for our contributors.

Also like johnny-five guidelines a lot; they walk you through submitting an issue, testing etc 🎉

I, however, don't want to block this. I think we can totally merge this, and then improve it if we so wish to ^.^

@bcoe
Copy link
Member Author

bcoe commented Jan 15, 2016

@nexdrew I agree, we should create a separate email at some point -- I'm going to use my personal email for the time being so that we can land this and cut a release, but I'll look into setting up a free Google Organization.

bcoe added a commit that referenced this pull request Jan 15, 2016
added contributor code of conduct, and contribution guidelines
@bcoe bcoe merged commit 785228b into master Jan 15, 2016
@bcoe bcoe deleted the contributing branch January 15, 2016 06:11
@lrlna
Copy link
Member

lrlna commented Jan 15, 2016

YAY! contributing.md is a thing! 🎊 🍃 Thanks @bcoe !

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.

4 participants