[openstack-dev] [all] Adding CONTRIBUTING.rst files to projects

Ian Cordasco sigmavirus24 at gmail.com
Wed Dec 21 15:55:07 UTC 2016


-----Original Message-----
From: Andreas Jaeger <aj at suse.com>
Reply: OpenStack Development Mailing List (not for usage questions) <openstack-dev at lists.openstack.org>
Date: December 21, 2016 at 09:48:20
To: OpenStack Development Mailing List (not for usage questions) <openstack-dev at lists.openstack.org>
Subject:  Re: [openstack-dev] [all] Adding CONTRIBUTING.rst files to projects

> On 2016-12-21 16:22, Ian Cordasco wrote:
> > [...]
> > That said, I think there are two better places for this information
> > that are already standards in OpenStack:
> >
> > * README.rst
> > * HACKING.rst
> >
> > Most projects include links to the contributing documentation in at
> > least one of these files. I think the effort here is to standardize,
> > albeit in a brand new file, and that's admirable.
> If that's the goal - to standardize - then I would expect that we move
> all the documentation out of those files in one place. 

The best reasoning I can come up with for a mass number of changes like this is to standardize a bit. I could be entirely wrong, but sending these changes in the interest of standardization is the best possible assumption I can make about the contributor's intentions.

> Right now, the changes duplicate information that exists - and the new
> information is often wrong. It points to place that do not exist or
> where better places exist. ;(

I agree. This is why I've been -1'ing or -2'ing these patches on projects.

> I'm fine with the status quo - of using the two files that you mention.
> Having contribution information is important,

The status quo is far from perfect, but it seems to have worked well enough for a few years now.

Ian Cordasco

More information about the OpenStack-dev mailing list