The latest articles on DEV Community by Ishan Makadia (@ishanmakadia). https://dev.to/ishanmakadia 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%2F422697%2F0a4ad47b-d452-40cf-af58-52a25da058b6.PNG https://dev.to/ishanmakadia en Ishan Makadia Sun, 21 Mar 2021 07:37:38 +0000 https://dev.to/ishanmakadia/git-commit-message-convention-that-you-can-follow-1709 https://dev.to/ishanmakadia/git-commit-message-convention-that-you-can-follow-1709 <p>Motivation of this blog is to curate all information at one place and to make more people aware about standards followed by industry.</p> <p>Let's get started.....</p> <blockquote> <p>A typical git commit message will look like<br> </p> </blockquote> <div class="highlight js-code-highlight"> <pre class="highlight plaintext"><code>&lt;type&gt;(&lt;scope&gt;): &lt;subject&gt; </code></pre> </div> <h2> "type" must be one of the following mentioned below! </h2> <ul> <li> <code>build</code>: Build related changes (eg: npm related/ adding external dependencies) </li> <li> <code>chore</code>: A code change that external user won't see (eg: change to .gitignore file or .prettierrc file)</li> <li> <code>feat</code>: A new feature</li> <li> <code>fix</code>: A bug fix</li> <li> <code>docs</code>: Documentation related changes</li> <li> <code>refactor</code>: A code that neither fix bug nor adds a feature. (eg: You can use this when there is semantic changes like renaming a variable/ function name)</li> <li> <code>perf</code>: A code that improves performance</li> <li> <code>style</code>: A code that is related to styling</li> <li> <code>test</code>: Adding new test or making changes to existing test</li> </ul> <h2> "scope" is optional </h2> <ul> <li>Scope must be noun and it represents the section of the section of the codebase</li> <li> <a href="http://karma-runner.github.io/1.0/dev/git-commit-msg.html">Refer this link for example related to scope</a> </li> </ul> <h2> "subject" </h2> <ul> <li>use imperative, present tense (eg: use "add" instead of "added" or "adds")</li> <li>don't use dot(.) at end</li> <li>don't capitalize first letter</li> </ul> <p><a href="https://github.com/eslint/eslint/commits/master">Refer this link for more practical examples of commit messages</a></p> <h4> References: </h4> <ul> <li><a href="https://www.conventionalcommits.org/en/v1.0.0/">https://www.conventionalcommits.org/en/v1.0.0/</a></li> <li><a href="https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716">https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716</a></li> <li><a href="https://github.com/fteem/git-semantic-commits">https://github.com/fteem/git-semantic-commits</a></li> </ul> github webdev productivity git