[Python-Dev] GH-NNNN vs #NNNN in merge commit

[Terry Reedy]

On 1/25/2018 10:38 PM, Brett Cannon wrote:
> 
> 
> On Thu, 25 Jan 2018 at 17:33 Eric V. Smith <eric at trueblade.com 
> <mailto:eric at trueblade.com>> wrote:
> 
>     On 1/25/2018 8:13 PM, Terry Reedy wrote:
>      > On 1/25/2018 7:47 PM, Mariatta Wijaya wrote:
>      >> I think we're starting to deviate from the original topic here which
>      >> is: please replace # with GH- when you click Squash & Merge button.
>      >
>      > I will try to remember to do this, although it seems pointless if
>     most
>      > people do not.
> 
> 
> Just because people are forgetting doesn't mean we shouldn't try to 
> change people's habits for the better. If it continues to be an issue 
> then we can talk about not caring, but for now we should try and spare 
> us future pain like we have had with e.g. issue numbers across various 
> issue trackers where you don't know which tracker a number is pointing 
> you towards.

I have not (yet) suffered such pain so it is not real to me.  However, I 
saw Mariatta's patch to issue a reminded, and that convinces me that you 
all Really Mean It.

> And since you have brought it up a couple of times, Terry, we can't 
> automate this reformatting if you press the Merge button, hence the 
> suggestion of a bot to do the final commit.

An optional bot with clearly defined behavior will be ok.  It would be 
useful when the initial commit message is written to be the merge 
message and there are either no additional commits or one will be happy 
with whatever the clearly defined behavior is with regard to addition 
commit messages.

>     I sometimes forget, too.
> 
>     Since changing this in the github workflow seems hard, how about sending
>     an email to the committer after the commit if this mistake is detected?
>     I know that in my case, if I were reminded a few times, I would be
>     better at doing it correctly in the future.

I believe https://github.com/python/bedevere/pull/82 will add a comment, 
which will get emailed to everyone nosy on the PR.

-- 
Terry Jan Reedy