docs(CONTRIBUTING): add some real examples of scopes
It became apparent in #3574 that it's not clear what scope should be.
Added `CONTRIBUTING` as suggested by @Diadlo.
Added `build` as suggested by @initramfs.
Also improve formatting of the file, so that it will conform to <=80
chars per line for markdown.
@ -77,9 +77,11 @@ The **header** is mandatory and the **body** is optional. The **scope** of the
@@ -77,9 +77,11 @@ The **header** is mandatory and the **body** is optional. The **scope** of the
header is also optional.
### Header
The header must be a short (72 characters or less) summary of the changes made.
#### Type
Must be one of the following:
* **feat**: A new feature
@ -87,8 +89,8 @@ Must be one of the following:
@@ -87,8 +89,8 @@ Must be one of the following:
* **docs**: Documentation only changes
* **style**: Changes that do not affect the meaning of the code (white-space,
formatting, etc), but change the style to a more appropriate one
* **refactor**: A code change that only improves code readability
and reduces complexity, without changing any functionality
* **refactor**: A code change that only improves code readability and reduces
complexity, without changing any functionality
* **perf**: A code change that improves performance
* **revert**: Reverts a previous commit
* **test**: Adding missing tests
@ -96,19 +98,36 @@ Must be one of the following:
@@ -96,19 +98,36 @@ Must be one of the following:
as documentation generation
##### Revert
If the commit reverts a previous commit, it should begin with `revert: `,
followed by the header of the reverted commit. In the body it should say:
`Revert commit <hash>.`, where the hash is the SHA of the commit being reverted.
`Revert commit <hash>.`, where the hash is the SHA of the commit being
reverted.
#### Scope
The scope could be anything specifying place of the commit change. For example