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

Alexandra Settle a.settle at outlook.com
Thu Dec 22 13:26:06 UTC 2016

My recommendation, as a documenter for OpenStack, would be to include a link to each project’s contributor guidelines (as most tend to keep in their developer documentation pages) in the README file.

I appreciate the README as previously not always been for this purpose, but I believe it would be beneficial to include a link and not to create a whole new file for the purpose of 3 lines.

I have had people in the past ask me how to contribute to individual project repositories, not knowing that each project has developer documentation that includes contributing documentation. There is clearly a gap, and this is just one option to fix that.

I appreciate if people disagree whoever, I don’t overly believe this is a necessary step as the contributor guidelines are already documented and this is a form of duplication.



On 12/22/16, 12:46 PM, "Ian Cordasco" <sigmavirus24 at gmail.com> wrote:

    On Wed, Dec 21, 2016 at 11:20 PM, Zhenyu Zheng
    <zhengzhenyulixi at gmail.com> wrote:
    > Agreed with Amrith, it might be useful and maybe also good for new
    > contributors to learn how to have a commit to OpenStack. BUT over 130
    > identical patches to 130 different projects from one company/person in one
    > run? I don't think this is going to help OpenStack growing. We should not
    > let this happen.
    > On Thu, Dec 22, 2016 at 12:44 AM, Amrith Kumar <amrith at tesora.com> wrote:
    >> For those who would like to know exactly what this set of changes cost in
    >> the CI, the answer is approximately 1050 jobs which consumed 190 compute
    >> hours of CI time.
    >> -amrith
    >> -----Original Message-----
    >> From: Amrith Kumar [mailto:amrith at tesora.com]
    >> Sent: Wednesday, December 21, 2016 11:13 AM
    >> 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
    >> Ian, Andreas, Emilien,
    >> My sentiments on the subject of these kinds of "production line" changes
    >> is unchanged from [1] and [2]. A complete list of these changes is at [3].
    >> I've updated all of the changes in this thread with a block comment and a
    >> -1. My apologies to other reviewers (and active contributors in those
    >> projects) for this automated comment across 131 commits.
    >> It is high time we eliminated these kinds of changes which do little to
    >> improve the overall quality of the product and serve merely to generate a
    >> huge amount of pointless work on the CI systems, and boost some meaningless
    >> statistics that someone wants to put on a slide someplace.
    >> -amrith
    >> [1] http://openstack.markmail.org/thread/dsuxy2sxxudfbij4
    >> [2] http://openstack.markmail.org/thread/3sr5c2u7fhpzanit
    >> [3] https://review.openstack.org/#/q/topic:addCONTRIBUTING.rst
    So, I want to reiterate why I started this thread:
    I want a productive outcome of this contributor's efforts. -1'ing
    everyone of their changes was not something I was looking for. Having
    people pile on after those -1s is also not something that leads to a
    productive outcome.
    Yes, these mass produced changes are annoying. I get it. We're all a
    little jaded, ostensibly because we've all seen the statistical
    nonsense that people at our very own companies use for marketing or
    whatever else. I understand it quite well.
    All of that aside, I specifically asked that we not turn this thread into that.
    There is some ambiguity right now with projects as to where to put
    easy-to-find documentation (even if it is just a brief paragraph with
    a link to longer-form documentation) into our repositories. Let's
    focus on that discussion here. We can come up with a productive
    conclusion and work with this contributor. While you've chosen (and
    yes, you've chosen this) to have a negative assumption about this
    contributor's efforts, I've chosen to believe they're looking to fill
    a gap. Increasing the productivity of new contributors to OpenStack is
    a positive improvement for our community. It may not fix a bug or add
    a feature, but it helps ramp up the people who will do that.
    So please, let's keep this productive. If you want to discuss ways of
    ratelimiting patchset contributions or some other nonsense, please
    start a new thread.
    Ian Cordasco
    OpenStack Development Mailing List (not for usage questions)
    Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe

More information about the OpenStack-dev mailing list