You can commit your code like this:
Basic: git commit -m <message>
Detailed: git commit -m <title> -m <description>
Conventional Commit is a formatting convention that provides a set of rules to formulate a consistent commit message structure like so:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
The commit type can include the following:
feat
β a new feature is introduced with the changesfix
β a bug fix has occurredchore
β changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies)refactor
β refactored code that neither fixes a bug nor adds a featuredocs
β updates to documentation such as a the README or other markdown filesstyle
β changes that do not affect the meaning of the code, likely related to code formatting such as white-space, missing semi-colons, and so on.test
β including new or correcting previous testsperf
β performance improvementsci
β continuous integration relatedbuild
β changes that affect the build system or external dependenciesrevert
β reverts a previous commit
Example:
fix: fix foo to enable bar
This fixes the broken behavior of the component by doing xyz.
BREAKING CHANGE
Before this fix foo wasn't enabled at all, behavior changes from <old> to <new>
Closes D2IQ-12345
You can use this comment convention on different kinds of framework or platform.