I read once that git commit messages should be in the imperative present tense, e.g. “Add tests for x”. I always find myself using the past tense, e.g. “Added tests for x” though, which feels a lot more natural to me.
Here’s a recent John Resig commit showing the two in one message:
Tweak some more jQuery set results in the manipulation tests. Also fixed the order of the expected test results.
Does it matter? Which should I use?
7 s
The preference for present-tense, imperative-style commit messages comes from Git itself. From Documentation/SubmittingPatches in the Git repo:
Describe your changes in imperative mood, e.g. “make xyzzy do frotz”
instead of “[This patch] makes xyzzy do frotz” or “[I] changed xyzzy
to do frotz”, as if you are giving orders to the codebase to change
its behavior.
So you’ll see a lot of Git commit messages written in that style. If you’re working on a team or on open source software, it is helpful if everyone sticks to that style for consistency. Even if you’re working on a private project, and you’re the only one who will ever see your git history, it’s helpful to use the imperative mood because it establishes good habits that will be appreciated when you’re working with others.