Difference between revisions of "StandardCommitMessages"

From Coder Merlin
 
Line 16: Line 16:
== Breaking Changes ==
== Breaking Changes ==
Breaking changes should be emphasized with the text BREAKING CHANGE:
Breaking changes should be emphasized with the text BREAKING CHANGE:
== Examples ==
<pre>
fix(pencil): stop graphite breaking when too much pressure applied
</pre>
<pre>
feat(pencil): add 'graphiteWidth' option
</pre>
<pre>
perf(pencil): remove graphiteWidth option
BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.
</pre>


== References ==
== References ==

Latest revision as of 16:02, 1 May 2020

Within these castle walls be forged Mavens of Computer Science ...
— Merlin, The Coder

Format[edit]

<type>[optional scope]: <description>

Types[edit]

build
Changes to the build process or auxiliary tools and libraries such as documentation generation
docs
Documentation only changes
feat
Implementation of a new feature in code
fix
Correction of an error in code
perf
Improving performance
refactor
A code change that neither fixes a bug nor adds a feature with the primary goal of increasing code clarity, readability, etc.
style
Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
test
Adding missing or correcting existing tests

Breaking Changes[edit]

Breaking changes should be emphasized with the text BREAKING CHANGE:

Examples[edit]

fix(pencil): stop graphite breaking when too much pressure applied


feat(pencil): add 'graphiteWidth' option


perf(pencil): remove graphiteWidth option

BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.

References[edit]