Hacker News new | ask | show | jobs
by __strisk 3437 days ago
don't use git commit messages as "dear diary" sort of things.

For example:

"I fixed the button issue on the homepage. Still, need to center the title."

would be better written as:

"fixes button issue on homepage"

Always think about what that commit does to the codebase. This is obviously for single-line commits. I suppose it would be okay to "dear diary" in the commit body. You can provide rationality or context in the commit body.

1 comments

My recommended style is:

    Fix button issue on homepage
    
    This allows the title to be centered,
    as the button will no longer collide with it.
Then, in a subsequent commit, center the title and put a reference to this one if you feel it's important, like so:

    Center the title on the homepage
    
    It wasn't previously because it would collide with the button,
    but that was fixed in f00b1f.