Commit Messages Can Be Semantic As Well!

less than 1 minute read

Motivation

If you’ve contributed to some open-source projects, you might have seen people writing something like feat, fix, docs, etc. If you’ve seen them, were you not curious about what they are? They are semantic commit messages (aka conventional commits).

Semantic commit messages

Credits: https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional.

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)
    • I usually write this when I pull from the main branch.

References:

Closing

Thanks for reading! I’ll come back with another post.

Tags:

Categories:

Updated:

Leave a comment