[openstack-dev] Add CONTRIBUTING file?

John Griffith john.griffith at solidfire.com
Wed Nov 21 18:43:53 UTC 2012


On Wed, Nov 21, 2012 at 11:31 AM, Doug Hellmann <doug.hellmann at dreamhost.com
> wrote:

>
>
> On Wed, Nov 21, 2012 at 12:51 PM, Monty Taylor <mordred at inaugust.com>wrote:
>
>>
>>
>> On 11/21/2012 09:43 AM, Daniel P. Berrange wrote:
>>
>>> On Wed, Nov 21, 2012 at 09:26:53AM -0800, Monty Taylor wrote:
>>>
>>>> Hey all!
>>>>
>>>> When you go to add a new repo on github, you get this message:
>>>>
>>>> "We recommend that every repository has a README, LICENSE,
>>>> CONTRIBUTING, and .gitignore."
>>>>
>>>> I certainly agree with them on 3 of the 4 - but I've never really
>>>> thought about having a CONTRIBUTING file. It seems like a good idea
>>>> though - especially since we have a kind-of specific workflow for
>>>> contribution.
>>>>
>>>> What do people think? Should we add that file? In it, should we
>>>> include the text of our contribution instructions, or just a small
>>>> snippet that directs people to the website with a quick 3-second
>>>> "sign cla, download git-review, submit"?
>>>>
>>>
>>> For most projects I'm involved with this kind of info would
>>> be either in the README file or the HACKING file. I don't
>>> actually remember seeing use of a CONTRIBUTING file before.
>>>
>>
>> Yeah, me either - but hell, if it's something github are about to be
>> pushing people to do, I mean, I don't want to be the one without skinny
>> jeans and a beard this time around...
>
>
> https://github.com/blog/1184-contributing-guidelines
>
> If we add the files, github will show a "Check the guidelines for
> contributing to this repository" link  for us and we may avoid having
> potential contributors send pull requests (I saw a couple of those go by
> this week) instead of following the desired workflow.
>
> Doug
>
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
> I vote we add it and just have a link to the how to contribute wiki page.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20121121/069ad510/attachment.html>


More information about the OpenStack-dev mailing list