Posts

Git commit messages

I think i love git (ThankYou Linus T)

As a junior dev, you may be surprised when #real engineers write great commit messages yet yours look like garbage (yes, it is garbage)

Here is a simple guide for it:

It should simply involve:

1. Subject heading ( less than 50 characters)
2. Description (mostly 72 words)

Naming conventions:

• chore: changes that don't affect code functionality eg maintenance tasks such as updating or installing npm packages
• feat: addition of a new feature to the existing codebase
• refactor: improving structure of existing code without adding new functions or features
• fix: when you have fixed existing code bugs or errors
• test: when your commit has new or modified tests
• docs: when you change documentation
• style: when stylistic changes are made to the codebase without affecting functionality
• perf: when you have improved performance of the codebase

For more naming conventions:
https://www.conventionalcommits.org/en/v1.0.0/

Examples of messages: (your git log should tell a story)

• chore: install Stripe
• "install stripe to enable payments"

• style: fix indentition
• "fix indentition throughout the codebase"

Write commit messages in present form eg install stripe not installed stripe
Do this more often, especially with your personal projects (which you will never finish)
Also install gitLens VSCode extension, lazygit for efficiency.
Gitlens:



Lazygit (it's better i promise):



Your git log should look like this:



Here is a great example: https://x.com/ronnieonly/status/1790799389578944813