Hi devs
When merging PRs with GitHub's "Squash and merge" button, please watch
out for the following two gotchas that can contaminate the commit log in
master.
1. Single commit PRs. GitHub defaults the squashed commit message to
that of the commit in the PR, rather than the PR title.
2. Multi-commit PRs. GitHub defaults the squashed commit message to the
PR title but includes a listing of the PR's individual commit messages
in the detail section, leading to commit message detail like "WIP, tests
passing now, revert first attempt, WIP, fix checkstyle, RAT got me
again, satisfy pedantic reviewers, ..." in the master commit log.
In both cases please manually ensure the commit message is the PR title
(e.g. DRILL-9999: New turbo encabulator) and if you put anything in the
commit message detail section, let it be the description section from
the PR and/or an important extra note e.g. "BREAKING, Drill 1.x users
control this behaviour with a global config option but now it is
controlled from storage configs."
Thanks!
James
