From d2d37230ceadbeeaa907c774562f0d50dee93a0f Mon Sep 17 00:00:00 2001 From: Alex Wilson Date: Tue, 23 Oct 2018 18:15:42 +0100 Subject: [PATCH] fix: Remove spec ambiguity between body and footer 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 --- content/next/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/next/index.md b/content/next/index.md index 55c3ce7..b83ae7f 100644 --- a/content/next/index.md +++ b/content/next/index.md @@ -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._