Libre Software People's Front

don't confuse it with People's Front of Open Source

Posts Tagged ‘netiquette

Use the imperative, Luke

leave a comment »

When you commit changes on a repository that fix a bug, what do you put in the message log?:

  • Fixed bug (adjetive)
  • Fixes bug (3rd person, the commit fixes the bug)
  • Fix bug (imperative)

For me it is logic to use the 2nd approach which details what the commit modifies but according to the de facto standard the most recommended form is the 3rd one. The Git documentation to submit patches suggest that the body should provide a meaningful commit message, which uses the imperative, present tense: “change”, not “changed” or “changes”. Tim Pope explains this in his blog saying that this convention matches up with commit messages generated by commands like git merge and git revert.

Next time you do a commit, remember to be imperative as if you were the Master of Puppets Commits 😛

Advertisements

Written by sanacl

March 1, 2011 at 12:11 am

Posted in Uncategorized

Tagged with , , ,