Here is my earlier post on this:
https://exploreeclipse.blogspot.com/2012/11/template-for-git-messages.html
Here is something new which I found. Probably, industry will align with these standards sooner or later.
https://www.conventionalcommits.org
https://exploreeclipse.blogspot.com/2012/11/template-for-git-messages.html
Here is something new which I found. Probably, industry will align with these standards sooner or later.
https://www.conventionalcommits.org
Format suggested:
<type>[optional scope]: <description>
[optional body]
[optional footer]
The commit contains the following structural elements, to communicate intent to the consumers of your library:
- fix: a commit of the type
fix
patches a bug in your codebase (this correlates withPATCH
in semantic versioning). - feat: a commit of the type
feat
introduces a new feature to the codebase (this correlates withMINOR
in semantic versioning). - BREAKING CHANGE: a commit that has the text
BREAKING CHANGE:
at the beginning of its optional body or footer section introduces a breaking API change (correlating withMAJOR
in semantic versioning). A breaking change can be part of commits of any type. e.g., afix:
,feat:
&chore:
types would all be valid, in addition to any other type. - Others: commit types other than
fix:
andfeat:
are allowed, for example commitlint-config-conventional (based on the the Angular convention) recommendschore:
,docs:
,style:
,refactor:
,perf:
,test:
, and others. We also recommendimprovement
for commits that improve a current implementation without adding a new feature or fixing a bug. Notice these types are not mandated by the conventional commits specification, and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE, which is NOT recommended).
A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g.,feat(parser): add ability to parse arrays
.
No comments:
Post a Comment