Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    text
    copied!<p>I wrote a fuller description on <a href="http://365git.tumblr.com/post/3308646748/writing-git-commit-messages" rel="noreferrer">365git</a>.</p> <blockquote> <p>The use of the imperative, present tense is one that takes a little getting used to. When I started mentioning it, it was met with resistance. Usually along the lines of “The commit message records what I have done”. But, Git is a distributed version control system where there are potentially many places to get changes from. Rather than writing messages that say what you’ve done; consider these messages as the instructions for what applying the commit will do. Rather than having a commit with the title:</p> <blockquote> <p><code>Renamed the iVars and removed the common prefix.</code></p> </blockquote> <p>Have one like this:</p> <blockquote> <p><code>Rename the iVars to remove the common prefix</code></p> </blockquote> <p>Which tells someone what applying the commit will do, rather than what you did. Also, if you look at your repository history you will see that the Git generated messages are written in this tense as well - “Merge” not “Merged”, “Rebase” not “Rebased” so writing in the same tense keeps things consistent. It feels strange at first but it does make sense (testimonials available upon application) and eventually becomes natural.</p> <p>Having said all that - it’s your code, your repository: so set up your own guidelines and stick to them.</p> <p>If, however, you do decide to go this way then <code>git rebase -i</code> with the reword option would be a good thing to look into.</p> </blockquote>
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload