git commit log convention

Justin Obara obara.justin at gmail.com
Fri Sep 9 18:24:01 UTC 2011


When we first made the move to Git, I had mentioned that there was convention on how commit logs should be formatted. We haven't paid too much attention to this because most of the Git UI's we've been using didn't take it into account. However, github is starting to follow this convention for formatting commit logs on their site now. Following this convention should go a long way to ensuring that we have well formatted commit logs across Git UI's.

https://github.com/blog/926-shiny-new-commit-styles

Git commits should start with a short summary, 50 characters or less, followed by a longer more detailed description. You can think of it like writing an e-mail. Also, some UI's need you to have a space between the summary line and the longer description.

Thanks
Justin


More information about the fluid-work mailing list