Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Semantic Commit Messages

Semantic Commit Messages

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)

Reference(s):

@YelemyahM

This comment has been minimized.

Copy link

commented Oct 15, 2018

Thanks it's very useful

@codebender828

This comment has been minimized.

Copy link

commented Dec 7, 2018

Thanks. Good stuff

@Keftaa

This comment has been minimized.

Copy link

commented Jan 9, 2019

Thanks

@lwwcas

This comment has been minimized.

Copy link

commented Jan 15, 2019

Starting today, I'll start using it, thanks

@kevinjalbert

This comment has been minimized.

Copy link

commented Jan 28, 2019

Wanted to drop this here as well: https://www.conventionalcommits.org

@tobyokeke

This comment has been minimized.

Copy link

commented Mar 15, 2019

thanks.

@keymusicman

This comment has been minimized.

Copy link

commented Mar 23, 2019

How about intermediate commits? For example, a big feature that has not been completed by the moment but should be commited and pushed. How is it better to write such commit message?

@YourSouLi5Mine

This comment has been minimized.

Copy link

commented Apr 5, 2019

@keymusicman you can use wip for work in progress

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.