git notes main page | gitolite main page | license

IMPORTANT NOTE: although this page has a "gitolite.com" URL, this is not about gitolite. That's just an artifact of "sitaramc.github.com" being translated to "gitolite.com" and so ALL my git related stuff gets carried over. Gitolite documentation has another /gitolite in the URL, so you can tell. My apologies for this confusion.

version control habits of good developers

(not necessarily git-specific)

This article is based on https://blog.bstpierre.org/version-control-habits – a blog post that is well worth checking out, especially if you want more details. However, this article represents my priorities on this matter, and most of the words are mine.

write useful, readable, commit messages

A good description of this is at https://www.tpope.net/node/106. But briefly, try and stick to the following guidelines:

Git uses the “subject” part in many places and it is very useful to have a short, meaningful subject line for each commit.

Needless to say, these guidelines are easier to follow if you follow the earlier ones; for example, it’s easier to write a useful commit message if you have not dumped four unrelated changes into the same commit ;-)