Live data from Hacker News

Is this a good commit message?

core.trac.wordpress.org

21–30 of 49 posts

Re: Is this a good commit message?

#22
post #17

I don't know. The writing is okay, there weren't any spelling mistakes that I noticed, but the use of three words written in only capital letters was somewhat disconcerting. I'd say if the author wants to get it accepted for publication somewhere reasonably mainstream he's going to need someone else working at arm's length who is willing to take the time to go through it and highlight areas for revision and expansion…

Subsides -> subsists. Not strictly spelling, but definitely a mistake... Otherwise a pretty awesome commit message. Better than my personal most used (before work moved to git and let me rewrite local history): "oops, forgot to add the new file" and "oops, fix up the bloody test"...

Yup, I realized the typo this morning. Hanging my head in shame. In fairness, this message was written at 4am after working for 18 hours straight (and 63 of the previous 84 hours, according to rescuetime).

Re: Is this a good commit message?

#25
post #22
post #17

Earlier quoted context omitted.

Subsides -> subsists. Not strictly spelling, but definitely a mistake... Otherwise a pretty awesome commit message. Better than my personal most used (before work moved to git and let me rewrite local history): "oops, forgot to add the new file" and "oops, fix up the bloody test"...

Yup, I realized the typo this morning. Hanging my head in shame. In fairness, this message was written at 4am after working for 18 hours straight (and 63 of the previous 84 hours, according to rescuetime).

[deleted]

Re: Is this a good commit message?

#26
post #22
post #17

Earlier quoted context omitted.

Subsides -> subsists. Not strictly spelling, but definitely a mistake... Otherwise a pretty awesome commit message. Better than my personal most used (before work moved to git and let me rewrite local history): "oops, forgot to add the new file" and "oops, fix up the bloody test"...

Yup, I realized the typo this morning. Hanging my head in shame. In fairness, this message was written at 4am after working for 18 hours straight (and 63 of the previous 84 hours, according to rescuetime).

In terms of git features, I think I value correcting embarrassing typos in my commit messages higher than fixing typos in my code! They're a lot more frequent due to the fast and loose typing, and lack of a compiler on my back.

Re: Is this a good commit message?

#28
No. People don't read commit logs for fun. They read them to try to find the source of a bug or who changed a line last and what they thought they were doing.

This breaks that functionality in two ways:

1. Recognizing the joke takes attention, which therefore means I have less attention available to track the thing I'm really hunting. The thing I'm hunting may take a lot of "state info" in my brain so I need that concentration. A commit log of "fix typo" can be quickly ignored without interrupting my brain state.

2. The commit log is not self-explainatory. You have to look at the diff to understand the joke. The whole point of a commit log is to summarize the change so I don't need to look at the diffs unless the commit is related to the functionality I'm investigating.

"Fix typo" followed by the joke would have been acceptable.

Re: Is this a good commit message?

#29
post #28

No. People don't read commit logs for fun. They read them to try to find the source of a bug or who changed a line last and what they thought they were doing. This breaks that functionality in two ways: 1. Recognizing the joke takes attention, which therefore means I have less attention available to track the thing I'm really hunting. The thing I'm hunting may take a lot of "state info" in my brain so I need that con…

[deleted]

Re: Is this a good commit message?

#30
post #26
post #22

Earlier quoted context omitted.

Yup, I realized the typo this morning. Hanging my head in shame. In fairness, this message was written at 4am after working for 18 hours straight (and 63 of the previous 84 hours, according to rescuetime).

In terms of git features, I think I value correcting embarrassing typos in my commit messages higher than fixing typos in my code! They're a lot more frequent due to the fast and loose typing, and lack of a compiler on my back.

If you're working in PHP, you should be used to fast and loose typing (also the lack of a compiler unless you work at Facebook).
Post reply on HN