Update Contributing Guide #7677

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
5 participants
Member

schneems commented Sep 18, 2012

There are a number of issues I've seen repeatedly come up in github issues I think we can fix by having them in this file. From minor issues like improper whitespace, to major ones like bug fixes and features getting abandoned because authors don't know how to properly rebase or squash.

While we already have a large amount of contribution information no http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html it still requires a user to click through and read the guide. My experience with readme's and wiki's on github is that most users expect the readme to summarize all topics, and any additional links to expand on them. Similarly it would be beneficial to our potential contributors to have all this information available at a glance on the contribution guide.

Inspiration for additional information from: http://contribute.md/ and @hone

For a preview check out: https://github.com/schneems/rails/blob/schneems/contribute/CONTRIBUTING.md

@schneems schneems Update Contributing Guide
There are a number of issues I've seen repeatedly come up in github issues I think we can fix by having them in this file. From minor issues like improper whitespace, to major ones like commits not getting accepted because authors don't know how to properly rebase or squash. 

While we already have a large amount of contribution information no http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html it still requires a user to click through and read the guide. My experience with readme's and wiki's on github is that most users expect the readme to summarize all topics, and any additional links to expand on them. Similarly it would be beneficial to our potential contributors to have all this information available at a glance on the contribution guide.

Inspiration for additional information from: http://contribute.md/ and @hone02
6cb04d5

Wow. Very clarifying, I'm one of those who expect the README to pass such information, right awa.

👍

Owner

fxn commented Sep 18, 2012

I am strongly 👎 on this one.

We better have one single place to explain people how to contribute to Rails, the new CONTRIBUTING.md would need this if we had not already a guide but we already do, so I believe this file has to link to the existing guide. People have to read the guide.

Member

vijaydev commented Sep 18, 2012

With @fxn on this. -1.

Owner

fxn commented Sep 18, 2012

OK, I think we can close this one. Richard, thanks for preparing the patch anyway, I see it took work.

The contributing guide may be improved, but we do not want some partial information here that may give the feeling that you can go on without reading the actual guide.

fxn closed this Sep 18, 2012

Member

schneems commented Sep 18, 2012

I'll look into updating the rails guide. I would still like to see common errors (the most common one being whitespace issues) eventually appear in this file, if we add those but keep this file short and keep insisting people read the contribution guide throughout this file - it would be the best of both worlds.


To better match your intentions for the reader, the line:

"Check out the [Contributing to Ruby on Rails] guide for a comprehensive introduction."

should be worded a bit stronger, something like:

"Read the [Contributing to Ruby on Rails] guide before submitting any code, it is a comprehensive introduction."

Owner

fxn commented Sep 18, 2012

That rewording sounds good to me, this file is in constant draft mode by now.

@schneems schneems added a commit to schneems/rails that referenced this pull request Sep 18, 2012

@schneems schneems Stronger wording in Contributing file
Explicitly tell users to read the guide before submitting code. re: #7677. Specify the name of the mailing list for rubyonrails-talk to help differentiate it from rubyonrails-core mailing list.
e69476a
Member

steveklabnik commented Sep 18, 2012

I want CONTRIBUTORS to be blue. :trollface:

Member

schneems commented Sep 18, 2012

Why is there no emoji for bikeshed on github? 🚲 🏠

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment