Posts

Showing posts with the label Commits

Which tense to Use while committing messages on GitHub

Image
Basically, the schools of thoughts are: Imperative (a.k.a. present tense) Should read like: Make foo do something Git uses the same imperative style and it shows when you do merges with commit messages:  Merge pull request #666 in kek from lord It tells someone what applying that commit will do, so it should read something like  If I apply this commit, it will [make foo do something...] More concise Past tense Should read like:  Made foo do something People reading the history tend to think of it in past tense…because HISTORY Reads more like a diary:  Last <insert date here>, I made foo do something.... Saving a couple of characters doesn’t matter much as long as it’s still easy to read The list goes on and on and the debates tend to go on forever, but I for one have seen both sides. I think it really depends on team preference — there is no right or wrong answer here. What matters is consistency. The team should agree on a convention and...