Please use conventional commit messages (Re: git: 2a9b7ca2a362)

[Michael Gmelin]

On Thu, 29 Apr 2021 13:22:46 +0200
Mathieu Arnold <mat at freebsd.org> wrote:

> On Thu, Apr 29, 2021 at 10:00:00AM +0000, Alexey Dokuchaev wrote:
> > On Thu, Apr 29, 2021 at 11:45:56AM +0200, Mathieu Arnold wrote:  
> > ...
> > > Please follow it.  
> > 
> > I know where it's documented; I might follow it at least for those
> > commits where it doesn't look as bad as it looks for others (e.g.,
> > which covert several ports).  However, I still didn't get the answer
> > as to why we are duplicating inferrable metainformation rather than
> > fixing the commit email template and/or configuring cgit properly.  
> 
> Well, it has nothing to do with email, it has to do with how commits
> are handled by Git.  In Git, the first line is the subject, and then
> you have the body of the commit.  The subject is not only about
> email, for example, if you run `git log --oneline`:
> 
> 2d719a7528bd (HEAD -> main, origin/main, origin/HEAD) Update to
> 9.16.15. 92ca026aa01c dns/bind911: Update to 9.11.31.
> 4507e5034cf7 net/wireguard-kmod: Update to 0.0.20210428
> e25cdb34606a sysutils/virtualmin: update to version 6.16.
> 004e688b9b43 audio/audacity Upgrade to 3.0.2
> 448693e731a7 www/chromium: update to 90.0.4430.93
> 
> or a more elaborate command like `git log --oneline --graph
> --date-order --all`:
> 
> * 2d719a7528bd (HEAD -> main, origin/main, origin/HEAD) Update to
> 9.16.15.
> * 92ca026aa01c dns/bind911: Update to 9.11.31.
> | * 44436ff0b0c0 (origin/2021Q2, 2021Q2) Update to 9.16.15.
> | * b273390548ec dns/bind911: Update to 9.11.31.
> * | 4507e5034cf7 net/wireguard-kmod: Update to 0.0.20210428
> * | e25cdb34606a sysutils/virtualmin: update to version 6.16.
> * | 004e688b9b43 audio/audacity Upgrade to 3.0.2
> | * a7dc410fd7d0 www/chromium: update to 90.0.4430.93
> | * 1e5773db640e www/chromium: mark BROKEN on 11/i386 for now
> | * 138633085148 www/chromium: update to 90.0.4430.85
> 
> You get only the first line, and the first line is where the most
> important bits have to go.
> 

It's also about using git's various built-in commands
(git-format-patch, git-squash, see git-commit(1)) comfortably. And all
external tooling, like IDEs. And mirrors (github, gitlab, etc.).

-m

-- 
Michael Gmelin