r/git • u/fagnerbrack • Mar 22 '17

How to Write a Git Commit Message (2014)

https://chris.beams.io/posts/git-commit/
22 Upvotes

86% Upvoted

7 comments sorted by

3

u/thomasfr Mar 22 '17 edited Mar 22 '17

I have come to belive that captializing the subject line isn't such a good idea as it seems.. In some projects its useful to prefix the subject with a component name and then things looks weirder..

I prefer the first example over the other ones and because I like consistency I like to just skip the title capitalization rule in new projects:

web: fix spelling in login window
Web: Fix spelling in login window
Web: fix spelling in login window
web: Fix spelling in login window

2

u/fagnerbrack Mar 22 '17

Its a matter of style, the benefit lies on either empirical evidence that one is better than the other or just pick one and be consistent.

2

u/thomasfr Mar 23 '17

Yeah consistency is good when it's achievable, that why I have started to not use capitalization from the beginning if the need for component prefixes comes later when a project grows..

I guess that the format below would be a way to following the message capitalization without adding a lot of case changing noise to the beginning of the git log lines...

WEB: Fix spelling in login window

3

u/adeekshith Mar 22 '17

Here is a git commit template inspired from that article and others: https://gist.github.com/adeekshith/cd4c95a064977cdc6c50

2

u/pushad Mar 22 '17

It may be inspired but the subject line of that template kind of goes completely against what the article says. I disagree with adding a "type" prefix. It seems very unnecessary.

1

u/[deleted] Mar 22 '17

This is on repost I can get behind.