https://www.vishalbhoriwal.me/tags/best-practices/Recent content in Best-Practices on Vishal BhoriwalHugoenSat, 10 Feb 2024 00:00:00 +0000https://www.vishalbhoriwal.me/blog/commit-messages/Sat, 10 Feb 2024 00:00:00 +0000https://www.vishalbhoriwal.me/blog/commit-messages/<p>A commit message is a letter to your future self. Make it worth reading.</p> <h2 id="the-problem-with-bad-commits">The Problem with Bad Commits</h2> <p>We&rsquo;ve all seen them:</p> <pre tabindex="0"><code>fix wip asdf final final FINAL </code></pre><p>These tell you nothing. Six months later, when a bug surfaces and you&rsquo;re spelunking through <code>git log</code>, these are useless noise.</p> <h2 id="the-rule-of-thumb">The Rule of Thumb</h2> <p>The subject line of a commit should complete this sentence:</p> <blockquote> <p><em>If applied, this commit will&hellip;</em></p> </blockquote> <p>So: &ldquo;Add input validation to login form&rdquo; rather than &ldquo;validation stuff&rdquo;.</p>