How much effort do you put into commit messages?
source link: https://dev.to/madza/how-much-effort-do-you-put-into-commit-messages-479g
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
How much effort do you put into commit messages?
Dec 31, 2020
・1 min read
Are you the 'lazy' type and often write them poorly and unorganized, with no proper explanation of the action and later have trouble navigating in the version tree?
Or do you always put in time and effort, trying to come up with meaningful, easy to understand git commit messages, and push them only when reaching reasonable milestones (finishing updates, adding features, changing the design, etc)?
Personally, I still have to learn to master this too, and, when it comes to the second case, some time ago I came across a nice comment by @devmount , so I decided to share and maybe some of you could find it useful:
Short and clear, thank you for this article!
I tend to use emojis for the type - it shows the type of the commit at first glance, e.g.:
➕ :heavy_plus_sign: when adding a file or implementing a feature
🔨 :hammer: when fixing a bug or issue
💚 :green_heart: when improving code or comments
⚡ :zap: when improving performance
📜 :scroll: when updating docs or readme
🔑 :key: when dealing with security
🔁 :repeat: when updating dependencies or data
✅ :white_check_mark: when a new release was built
👕 :shirt: when refactoring or removing linter warnings
❌ :x: when removing code or files
... and looks awesome in the commit history:
How much effort do you put into commit messages and could you share your own techniques to stay organized in the version tree?
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK