heiglandreas

joined 6 years ago
[–] heiglandreas@phpc.social 3 points 1 month ago

@Cyno IIRC I explicitly talked about the Jetbrains UI.

Others I didn't check and mean! Sorry if it came across like that!

[–] heiglandreas@phpc.social 3 points 1 month ago (16 children)

@BatmanAoD Besides that a git log and a changelog have different target audiences.

The gitlog is intended for contributors of the project whereas the chamgelog is intended for users of the project.

And it helps the users if they get a summarized version of what changed for them.without having to.go.theough each commit amd decide for themselves whether and how that internal change affects the exteenal API and then their usage of it.

[–] heiglandreas@phpc.social 4 points 1 month ago

@Xitnelat Indeed. But software can help.

After all an email editor also has different fields for different content, while it is perfectly possible to write an email.with a texteditor.

And while everything is possible, the "Subject line, empty line, Body (empty line, trailer)" is what it's intended to be.

So why not help the person in front of the monitor with that...

/cc @jetbrains

[–] heiglandreas@phpc.social 2 points 1 month ago (17 children)

@BatmanAoD Because they serve a different purpose.

Purely semantically a changelog is something different than a git log (otherwise it would be named a git log).

The changelog is more a log of merges that describes the main overview of new features and also bug fixes.

If I want to know the exact details why this line of code changed, *then* I look at the git log.

Having all atomic commitlogs in the changelog tells the user that you are too busy fixing code to give them a meaningful summary

[–] heiglandreas@phpc.social 4 points 1 month ago

@ramsey @jetbrains I'm still prepping a talk just about commit messages. The Why, How, what nots and Caveats - experiences from decades of code archeology... 🙈

Might just pitch that to the next CfPs....

[–] heiglandreas@phpc.social 0 points 1 month ago (26 children)

@ramsey Just: Don't.

The subject lines space is limited and should not be wasted for stuff that doesn't belong there.

Also the prime idea behind conventional commits is to add machine readable info.to the commit message: Fine. Do so. The commit.meysage can be as long as you want. Add it there. Keep the subject line to the human readable part.

Also: Creating changelogs from.git.commits is *not* what chamgelogs are there for.

Keep a changelog can help on *that* front.

@jetbrains

view more: ‹ prev next ›