Improve git log?

[st-pasha]

So, there is this unfortunate property of GitHub is that it tends to create horrible commit messages. What I mean is: when you press the [Squash and Merge] button on a PR, then GitHub will compose the final commit message by concatenating multiple the commit strings of all the constituent commits. Which ends up in messages that look like this:

    chore: analyze issues introduced from new dart version (#1196)
    
    * Added Component.childrenFactory
    
    * fix some of the lint warnings
    
    * more lint warnings
    
    * remove changelog entry
    
    * more analyzer warnings
    
    * one more warning
    
    * one more warning
    
    * remove more unused imports
    
    * fix more warnings
    
    * another warning
    
    * one more warning
    
    * a lot more warnings
    
    * some more warnings
    
    * fix warnings in flame_svg
    
    * fix warnings in flame_bloc
    
    * Remove OrderedSet override feature
    
    * Remove testRandom change
    
    * Remove unnecessary type checks
    
    * Re-remove deprecated argument in random_test
    
    Co-authored-by: Pasha Stetsenko <[email protected]>

IMHO, a much better alternative would have been if we used the content of the "Description" section for the ultimate commit message. For the commit above, it would've looked like this:

chore: Analyze issues introduced from new dart version (#1196)

The new dart analyzer got smarter and noticed that a lot of imports can be removed.

How to achieve this? The only way I know is to copy-paste the text of the description from the PR body and into the textbox that appears when you press the [Squash and Merge] button. It should only take maybe 5 seconds or so? The benefits are:

• The output of git log is much more legible;
• Added incentive for PR authors to compose good PR descriptions.