I am afraid people won't read it anyway. the PR template should be as short as possible. I think this one is really something that should be on reviewers. It's one of those things that is hard to automate or delegate.
If the reviewer does not understand what the PR from the description, it should be the first point to say "please provider context, I am not sure what the change does" even before looking at the code IMHO. If we all do that - this will be much more effective than writing it in the template. J On Thu, Sep 10, 2020 at 3:14 PM Ry Walker <[email protected]> wrote: > > Maybe modify the template to include some copy from your email in it :) > > On Sun, Sep 6, 2020 at 6:56 AM Kaxil Naik <[email protected]> wrote: > > > Hi all, > > > > I have brought this topic on multiple occasions earlier too on the mailing > > list. I sincerely request all the contributors and Committers (including > > myself) that we add PR descriptions. > > > > This helps the community understand what the PRs do and abides by the ASF > > motto about "Community above Code", many users lands to the PR after > > checking change log and having to look at the code to understand the PR is > > not ideal. Adding descriptions of "most" of the PRs literally does not take > > more than a minute. > > > > We previously had automation around it but we removed because of small > > exceptions where the PR title can be self explanatory. > > > > We should not ignore rules (I am talking about PR template that says " ^ > > Add meaningful description above ". Again it is fine if the PR title is > > self explanatory but not otherwise. > > > > Regards, > > Kaxil > > -- Jarek Potiuk Polidea | Principal Software Engineer M: +48 660 796 129
