Hi all, I'm a bit confused by the last PR I merged (7ec74e5f). I was erroneously assuming that the part of commit messages such as: Closes #00000 from johnsmith/abc and squashes the following commits: xxxxxx [John Smith] first yyyyyy [John Smith] second ... was automatically added by Github when squashing. Instead it's apparently not the case. How do you typically create those commit messages? With the green button or locally? Do you manually write their entire content? Pietro
Hi Pietro, No, the github interface does not create such a commit message (it sometimes puts all the individual commit messages in the body, but without the details of the author and the hash for each squashed commit). It was our script (scripts/merge-pr.py) that created such commit messages, but nowadays we usually don't use that anymore, but rather use the green merge button on github itself. What I often do is edit the body of the generated commit message by github a little bit (eg if many of the individual squashed commit messages are "edit", "fixup", etc I just remove them, or otherwise keep the informative part), but nothing too fancy. Github always adds the PR number to commit title, so that way you can easily get back to the PR to look at individual squased commits if needed. Joris 2018-04-25 3:41 GMT+02:00 Pietro Battiston <me@pietrobattiston.it>:
Hi all,
I'm a bit confused by the last PR I merged (7ec74e5f). I was erroneously assuming that the part of commit messages such as:
Closes #00000 from johnsmith/abc and squashes the following commits:
xxxxxx [John Smith] first yyyyyy [John Smith] second
... was automatically added by Github when squashing. Instead it's apparently not the case.
How do you typically create those commit messages? With the green button or locally? Do you manually write their entire content?
Pietro _______________________________________________ Pandas-dev mailing list Pandas-dev@python.org https://mail.python.org/mailman/listinfo/pandas-dev
Thanks Jeff and Joris, I guess I know have a much clearer understanding - and less expectation for magic. Pietro Il giorno mer, 25/04/2018 alle 09.39 +0200, Joris Van den Bossche ha scritto:
Hi Pietro,
No, the github interface does not create such a commit message (it sometimes puts all the individual commit messages in the body, but without the details of the author and the hash for each squashed commit). It was our script (scripts/merge-pr.py) that created such commit messages, but nowadays we usually don't use that anymore, but rather use the green merge button on github itself.
What I often do is edit the body of the generated commit message by github a little bit (eg if many of the individual squashed commit messages are "edit", "fixup", etc I just remove them, or otherwise keep the informative part), but nothing too fancy. Github always adds the PR number to commit title, so that way you can easily get back to the PR to look at individual squased commits if needed.
Joris
2018-04-25 3:41 GMT+02:00 Pietro Battiston <me@pietrobattiston.it>:
Hi all,
I'm a bit confused by the last PR I merged (7ec74e5f). I was erroneously assuming that the part of commit messages such as:
Closes #00000 from johnsmith/abc and squashes the following commits:
xxxxxx [John Smith] first yyyyyy [John Smith] second
... was automatically added by Github when squashing. Instead it's apparently not the case.
How do you typically create those commit messages? With the green button or locally? Do you manually write their entire content?
Pietro _______________________________________________ Pandas-dev mailing list Pandas-dev@python.org https://mail.python.org/mailman/listinfo/pandas-dev
participants (2)
-
Joris Van den Bossche -
Pietro Battiston