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

first draft of CONTRIBUTING.md #258

Merged
merged 2 commits into from
May 23, 2016
Merged

first draft of CONTRIBUTING.md #258

merged 2 commits into from
May 23, 2016

Conversation

benmosher
Copy link
Member

Given the recent uptick in interest, I figure the time has come to get something like this into master. Feels a little goofy to do something like this for a project that is just a plugin for something much larger, but at the same time, this is my primary open source project and it's been getting a lot of great contributions lately.

Comments are encouraged. I've not tried to write anything like this before and in general my written voice can be confusing and pedantic at the best of times.

(closes #257)

@kentcdodds
Copy link
Contributor

You might checkout makeapullrequest.com and consider including that.

See also: https://github.com/nayafia/contributing-template

👍

@jfmengels
Copy link
Collaborator

I think it's really good, especially for a first draft. I especially like the tone of it.

It's a big block of text, but it does not feel like a huge todo list (not: I did read it as a reviewer, not a contributor) this one (which is very good too, especially with the really friendly tone, but there is a huge list of items in the todo list. Even though some are not real todos, but they feel like it).

I think that it might be a good idea to have the checklist at the top of the README though, maybe with a tl;dr comment, and putting an extra emphasis (putting it in bold or before the list) on Remember, you don't need to do it all yourself; any of these are helpful!. Especially helpful to people who are finishing their PR and want to re-check the todo list.

I'd put that at the top so that readers can quickly see what they need to do contribute. Having a big block of text can scare the reader off, and this could set their expectations quickly.

That said, great tone, great work :)

cc @ta2edchimp who might be interested in this too ;)

@ta2edchimp
Copy link

The CONTRIBUTING.md is really good! Especially including a Code of Conduct is a great idea!

@jfmengels thanks for letting me know of this!

- added link to @kentcdodd's contributing how-to course
- moved checklist to the top
@jfmengels
Copy link
Collaborator

This still looks very good to me, shall we merge this?

@benmosher benmosher merged commit e6e7551 into master May 23, 2016
@benmosher benmosher deleted the contributing branch June 1, 2016 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

CONTRIBUTING.md
4 participants