JetBrains

204 readers

11 users here now

A community for discussion and news relating to JetBrains and its products! https://www.jetbrains.com/

Related Communities

founded 1 year ago

MODERATORS

Vacant@programming.dev

After seeing people use the UI to commit to git I understand where all those - sorry: shitty - commit messages come from.... (phpc.social)

submitted 4 months ago by heiglandreas@phpc.social to c/jetbrains@programming.dev

30 comments fedilink hide all child comments

After seeing people use the @jetbrains UI to commit to git I understand where all those - sorry: shitty - commit messages come from....

🙈

An improvement would already be to have a "Subject" line and the text box.

And have the subject line follow the Beams Rule.

Sonthat the first line of the commit message finishes the sentence

"When this commit is applied it will..."

And please: No longer than 56(?) characters (Unicode). Keep it short. You got the textbox to explain *why* in full length.

you are viewing a single comment's thread
view the rest of the comments

[–] ramsey@phpc.social 3 points 4 months ago (23 children)

@heiglandreas @jetbrains What if you want to use Conventional Commits instead of Beams? 😉

[–] heiglandreas@phpc.social 0 points 4 months ago (22 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

[–] heiglandreas@phpc.social 4 points 4 months 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....

load more comments (21 replies)