Standardized Git Commit Messages
|
Type |
Purpose |
Common Scenarios |
Example Message |
|
feat |
New features |
Adding a button, creating a new API endpoint, or implementing a new page. |
feat(api): add user profile endpoint |
|
fix |
Bug fixes |
Patching a crash, fixing a broken link, or correcting logic errors. |
fix(ui): resolve mobile menu overlap |
|
docs |
Documentation |
Updating README, adding JSDoc comments, or fixing typos in docs. |
docs: update setup steps in readme |
|
style |
Formatting |
Fixing indentation, removing semi-colons, or running Prettier. |
style: run prettier on auth module |
|
refactor |
Code Cleanup |
Renaming variables for clarity or simplifying complex logic (no logic change). |
refactor: simplify loop in data parser |
|
perf |
Performance |
Speeding up database queries or reducing image file sizes. |
perf: lazy load homepage assets |
|
chore |
Maintenance |
Updating dependencies, changing .gitignore, or config file tweaks. |
chore: bump node version to 20.x |