How to write a Git Commit Message?

I recently realised about the importance of git commit messages when one of my co-workers who was looking at my Lisp Interpreter told me that my commit messages were not in a format. Until then I had never bothered to look into what makes a great commit message.

So what are the ingredients of a great commit message?
A common standard format to save soul searching.
1. Style
2. Content
3. Metadata

There are seven rules of a great Git commit message.
1. Separate the subject line from the body.
2. Limit the subject line to 50 characters.
3. Capitalize the subject line.
4. Do not end the subject line with a period.
5. Use imperative mood in the subject line.
6. Wrap the body in 72 characters.
7. Use the body to explain what , why and how [1].

I use a trello to remind me the same.
https://trello.com/b/mJA6Ceyi/how-to-write-a-git-commit


Links:
https://git-scm.com/book/en/v2
https://chris.beams.io/posts/git-commit/

[1] Chris Beams. "How to Write a Git Commit Message" . https://chris.beams.io/posts/git-commit/ . Last Accessed On: July 29, 2017



Comments

Post a Comment

Popular posts from this blog

Patroni, Docker Swarm, and the Silent Killer: A Deep Dive into MTU Mismatch

Background I was experimenting with patroni for PostgreSQL HA in multi-node docker swarm environment. One of the issues I used to repeatedly observe was about the loadbalancer ( postgres-service , which was HAProxy bundled with patroni) repeatedly crashing after I performed a switchover, promoting a secondary node to primary. This suggested the new primary (patroni leader) wasn't being detected as healthy. Debugging My initial line of thought was it is due to corrupted data directory for PostgreSQL, I went ahead and delete the docker volumes in all nodes in the multi-node cluster and restored the backup and everything came up fine.  I got curious! What if I hadn't deleted the docker volumes? What could be the reason for postgres-service crashing? I had a suspicion that PostgreSQL is unable to recover as WAL files sync is taking huge time between the nodes. But how could it be since all the nodes were in the same kvm and associated with same bridge interface. We migra...
Read more

Function Composition in JavaScript

Composing Functions is a great way to abstract two or more function under the hood. It is a great style to apply functions on your data. It is like the UNIX pipe command which takes the output of one command and applies it as input for the second command. Function Composition of two functions f and g can be defined as `f(g(x))` where it will be evaluated from right to left. x <- Your data g <- Your First function f <- Your Second Function The order of evaluation in this case would be g(x) whose output would act as input to the function f. const compose = f => g => x => f(g(x)) const add = x => x + 5 const multiply = y => y * 10 compose(add)(multiply)(2)  This so compose(add) would return a closure and then we pass another function which will return a closure and then we pass data to be acted on.     
Read more