From ee053d7b8c4cbb09c9a97b5ec835688a6069ac99 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Tue, 26 Feb 2019 18:57:07 +0000 Subject: [PATCH] docs(contributing): separate `BREAKING CHANGE` under its own heading * Explain that is should be formatted as a paragraph. * Show an example of how to supply it. --- CONTRIBUTING.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78297028..2a79c6b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,5 +69,20 @@ Type|Heading|Description|Bump (default)|Bump (custom) `style`|Styles|Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)|–|0.0.1 `test`|Tests|Adding missing or correcting existing tests|–|0.0.1 -* Adding `BREAKING CHANGE` to the footer of the extended description of the commit message will **always** trigger a `major` version change, no matter which type has been used. +### Use `BREAKING CHANGE` to trigger a `major` version change +Adding `BREAKING CHANGE` to the footer of the extended description of the commit message will **always** trigger a `major` version change, no matter which type has been used. +This will be appended to the changelog and release notes as well. +To preserve good formatting of these notes, the following format is prescribed: + +* `BREAKING CHANGE: .` + +An example of that: + +```git +... + +BREAKING CHANGE: With the removal of all of the `.sls` files under +`template/package/`, this formula no longer supports the installation of +packages. +```