The latest articles on DEV Community by Kenny Jinhiro (@jinhiro). https://dev.to/jinhiro https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F1406272%2F854938b9-25b1-479d-b84d-774bd0c809bf.jpg https://dev.to/jinhiro en Kenny Jinhiro Wed, 28 Aug 2024 14:47:35 +0000 https://dev.to/jinhiro/git-commit-messages-5g3d https://dev.to/jinhiro/git-commit-messages-5g3d <p><strong>TLDR: Start with a word that describes the whole code change. Then, make a 4-to-5 word sentence describing the whole code change.</strong></p> <p>Recommended Examples:</p> <ul> <li>Feat: Login</li> <li>Fix: iOS 16.0 Crash</li> </ul> <p>With these examples, you generally know what goes on. Points of reasons are given below.</p> <h2> 1. First Word Matters </h2> <blockquote> <p>A word that could describe the whole code change makes anyone <strong>generally know what goes on in your code.</strong></p> </blockquote> <p>These are the words that are conventionally used.</p> <p><strong>1. Feat</strong><br> <strong>New feature</strong> is being launched by the code change.</p> <p><strong>2. Fix</strong><br> <strong>A fix</strong> is done in the code change.</p> <p><strong>3. Test</strong><br> <strong>A test</strong> is added in the code change.</p> <p><strong>4. Chore</strong><br> <strong>A package</strong> is modified (added or removed) in the code.</p> <h2> 2. Commit Message </h2> <blockquote> <p><strong>4 or 5 words</strong> that could generalize the code changes is absolutely recommended. Less words? Better!</p> </blockquote> <p>Developers appreciate simplicity, look at these two examples:</p> <ol> <li>Test: Add new unit tests for user authenticating login functionality.</li> <li>Test: Added login tests</li> </ol> <p>Well, in the end, these guidelines aren't a must, but simpler description would make everyone happy.</p> git commit messages