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

[–] heiglandreas@phpc.social 1 points 4 months ago (1 children)

@BatmanAoD And the commit message *is* documentation. It explains the "Why" making transparent why the code was written the way it is. If the commit message doesn'T reflect that, then you can also use git commit -m "Fixed issues"

But again: That is then a people problem that no tech will solve!

[–] BatmanAoD@programming.dev 1 points 4 months ago

My point is that "the comments aren't accurate" is also a people problem. And I absolutely disagree that commit messages are "documentation" of anything except the development history.