loading...

Format of commit messages

nishantwrp profile image Nishant Mittal ・1 min read

What protocol do you follow while writing commit messages?

Also, who else thinks commit messages in lower case look more neat?

Discussion

markdown guide
 

Mostly just add an issue number where applicable and try and write a message which explains what changed in high level language for later "ex
PROJ-23 updated button to be hidden when mobile users view site", no real strict protocol

 

I typically use a prefix of FEAT, FIX, DOCS, or CLEAN followed by the lowercase message. I'm not too fancy

 

All about an issue number. If there is not an issue tied to it, it shouldn't be committed.

 

What Steven said. Technically we are supposed to keep the first line within 80 characters, and put detailed changes in a following paragraph, but nobody reads past the first line these days...

 

but nobody reads past the first line these days...

I think it always has been.
In 90% of cases, you need only high-level description of commit to understand what changes were related to. You need details only if you want to find out why that changes were made, e.g. when you have an issue related to that code.