Semantic Commit Messages

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:

• https://www.conventionalcommits.org/
• https://seesparkbox.com/foundry/semantic_commit_messages
• http://karma-runner.github.io/1.0/dev/git-commit-msg.html

Hi friends, if I make some changes like bug fixes and feature addition and I have to update the dependency management code (eg, composer.json, package.json, pom.xml, build.gradle etc) to reflect my release version, what would be the commit message for it. For example, I have a PHP composer package that I develop and maintain. I add a bug fix and a feature. The previous version is "version": "0.0.8", and I need to update my package version to be "version": "0.0.9", what would be the commit message for that composer.json.

In case you are looking for a more detailed git conventional cheatsheet feel free to have a look at https://gist.github.com/5dfcdf8eec66a051ecd85625518cfd13