This content originally appeared on DEV Community and was authored by Kenny Jinhiro
TLDR: Start with a word that describes the whole code change. Then, make a 4-to-5 word sentence describing the whole code change.
Recommended Examples:
- Feat: Login
- Fix: iOS 16.0 Crash
With these examples, you generally know what goes on. Points of reasons are given below.
1. First Word Matters
A word that could describe the whole code change makes anyone generally know what goes on in your code.
These are the words that are conventionally used.
1. Feat
New feature is being launched by the code change.
2. Fix
A fix is done in the code change.
3. Test
A test is added in the code change.
4. Chore
A package is modified (added or removed) in the code.
2. Commit Message
4 or 5 words that could generalize the code changes is absolutely recommended. Less words? Better!
Developers appreciate simplicity, look at these two examples:
- Test: Add new unit tests for user authenticating login functionality.
- Test: Added login tests
Well, in the end, these guidelines aren't a must, but simpler description would make everyone happy.
This content originally appeared on DEV Community and was authored by Kenny Jinhiro
Kenny Jinhiro | Sciencx (2024-08-28T14:47:35+00:00) Git: Commit Messages. Retrieved from https://www.scien.cx/2024/08/28/git-commit-messages-2/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.