TSI226 :sparkles: Talk about commit messages
Commit messages
- Why?
- Anatomy of a good commit message
- Example
Why?
Can you tell me what was the intention of the person who wrote these commit messages?
(The author has been removed for security reasons)
Why?
Can you tell me what was the intention of the person who wrote these commit messages?
(The author has been removed for security reasons)
Why?
Can you tell me what was the intention of the person who wrote these commit messages?
(Shit happens)
Why?
Can you tell me what was the intention of the person who wrote these commit messages?
Why?
Can you tell me what was the intention of the person who wrote these commit messages?
Why?
Can you tell me what was the intention of the person who wrote these commit messages?
Why?
Can you tell me what was the intention of the person who wrote these commit messages?
Why?
Can you tell me what was the intention of the person who wrote these commit messages?
Why?
Find a root cause of a problem: Git Blame
Why?
Find a root cause of a problem: Git History
Anatomy of the perfect commit message
Anatomy of a good commit message
TICKET_LABEL :emoji: Commit titleTICKET_LABEL: Team acronym + Ticket number
emoji: See change at a glance (https://gitmoji.carloscuesta.me/)
Commit title: Concise description of what the change is about
Anatomy of a good commit message
TICKET_LABEL :emoji: Commit titleDO/DON'T:
- DON'T
- Try to squeeze everything in this line
- git commit -am "I'm feeling a bit lazy today"
- Make it really big so it doesn't fit in Github main view
- Put articles or prepositions
- Start with infinitive
Anatomy of a good commit message
TICKET_LABEL :emoji: Commit title
Description of the problem solvedIf it is a bug, describe the issue and the fix you'r done.
If it is a new feature, I tend to summarize the part of the acceptance criteria I have completed
Anatomy of a good commit message
TICKET_LABEL :emoji: Commit title
Description of the problem solved
Description of the technical solutionOptional, give a summary of what you have done from a tech point of view.
I tend to avoid it, code should speak for itself.
Anatomy of a good commit message
TICKET_LABEL :emoji: Commit title
Description of the problem solved
Description of the technical solution
Description of tradeoffs and future improvementsIf you have incur in some tech debt or you think there could be improvements to be done.
Anatomy of a good commit message
TICKET_LABEL :emoji: Commit title
Description of the problem solved
Description of the technical solution
Description of tradeoffs and future improvements
Link to trello ticketAnatomy of a good commit message
TICKET_LABEL :emoji: Commit title
Description of the problem solved
Description of the technical solution
Description of tradeoffs and future improvements
Link to trello ticket
Person that you paired with (git duet)It is really nice if people can identify you in Github
Anatomy of a good commit message
TICKET_LABEL :emoji: Commit title
Description of the problem solved
Description of the technical solution
Description of tradeoffs and future improvements
Link to trello ticket
Person that you paired with (git duet)It is really nice if people can identify you in Github
