Skip to content

Instantly share code, notes, and snippets.

@joshbuchea

joshbuchea/semantic-commit-messages.md

Last active October 30, 2024 16:09
Show Gist options
  • Save joshbuchea/6f47e86d2510bce28f8e7f42ae84c716 to your computer and use it in GitHub Desktop.
Save joshbuchea/6f47e86d2510bce28f8e7f42ae84c716 to your computer and use it in GitHub Desktop.
Download ZIP
Semantic Commit Messages
Raw
semantic-commit-messages.md

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)

References:

@uncenter
Copy link

What'd you suggest to use if I remove a feature? If it caused bugs, it would be bugfix I guess. But what if it was just unnecessary?

bugfix isn't a conventional commit type, it would be fix. That also could be considered something breaking, so you can use an exclamation mark to mark it as such: fix!: xyz and remove abc feature.

@XxA7med66xX
Copy link

I learned something useful today, thanks!

@dogukancaner
Copy link

useful

@ayanchavand
Copy link

very cool

@rezzvy
Copy link

rezzvy commented Sep 2, 2024

Hi, if I add a new library like Bootstrap files to my project before creating the index.html, what tag should I use? I’ve been using 'chore' but it might be misleading. What do you think?

@showierdata9978
Copy link

feat: Include Libraries?

But I'd also just include them in the same commit with
feat: Initial Commit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment