ci: put commit id first in changelog

[joshka]

git cliff --unreleased

CHANGELOG.md

[codecov]

Codecov Report

Merging #463 (df74649) into main (e098731) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #463   +/-   ##
=======================================
  Coverage   90.00%   90.00%           
=======================================
  Files          40       40           
  Lines       11156    11156           
=======================================
  Hits        10041    10041           
  Misses       1115     1115           

[orhun]

How do you think this helps with readability? I think the current format is good and I would say let's stick to it for a while for consistency in the changelog :D

[joshka]

Mostly this is a cosmetic change backed by some subjective preferences.

Putting the commit ID first makes the visual design hierarchy more obvious by implying that each row in the changelog is strongly coupled with a commit. It also avoids the subjective messiness of having two parenthesized parts at the end of line (and avoids wrapping the commit id to the next line. By putting a fixed size piece of text at the beginning of a line, it allows someone reading to more easily ignore the first part when scanning down a list of items than if the same blue text is at the end of the line or on the following line. It's not a massive deal either way, but I think this is marginally nicer.

Current Changelog for comparison:

[mindoodoo]

@joshka Is the commit ID always wrapped to the next line as in your screenshot ?

[orhun]

Got it, I guess that's not a big deal. But let's try to keep a consistent changelog format for future releases 🐻

[joshka]

@joshka Is the commit ID always wrapped to the next line as in your screenshot ?

No - sorry. I'd pasted the output of git-cliff into a github comment and that renders this wrong. My mistake there.

[mindoodoo]

Aight, I guess I'm good either way, though I agree with orhun that we shouldn't change it up too often.

The change makes sense and will put an even stronger emphasis on writing clean commits.