mirrors/conventionalcommits.org
0
0
Fork 0
mirror of https://github.com/conventional-commits/conventionalcommits.org.git synced 2025-08-26 07:45:34 +00:00
Code

fix: Remove spec ambiguity between body and footer

Browse Source 
Prior to this change, if a message had a block of text after the type and description then it was ambiguous as to whether it was a body or a footer. This change resolves the issue by specifying that a footer can only follow (and therefore requires) a body, rather than a description.

Fixes #98
This commit is contained in:
Alex Wilson 2018-10-23 18:15:42 +01:00 committed by Damiano Petrungaro
parent f65ba78704
commit d2d37230ce
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/next/index.md
View File

@ -77,7 +77,7 @@ The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL
1. A description MUST immediately follow the type/scope prefix.
The description is a short description of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string._
1. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
1. A footer MAY be provided one blank line after the body (or after the description if body is missing).
1. A footer MAY be provided one blank line after the body.
The footer SHOULD contain additional issue references about the code changes (such as the issues it fixes, e.g.,`Fixes #13`).
1. Breaking changes MUST be indicated at the very beginning of the footer or body section of a commit. A breaking change MUST consist of the uppercase text `BREAKING CHANGE`, followed by a colon and a space.
1. A description MUST be provided after the `BREAKING CHANGE: `, describing what has changed about the API, e.g., _BREAKING CHANGE: environment variables now take precedence over config files._