From b0c4ecf563050eb1d91ad56c2671ea781fadd96f Mon Sep 17 00:00:00 2001 From: Marcono1234 Date: Mon, 16 Nov 2020 16:14:42 +0100 Subject: [PATCH] docs: improve commit message format documentation (#39705) PR Close #39705 --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df572aa5c8..61adf35b63 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -227,10 +227,10 @@ Each commit message consists of a **header**, a **body**, and a **footer**. The `header` is mandatory and must conform to the [Commit Message Header](#commit-header) format. -The `body` is mandatory for all commits except for those of scope "docs". -When the body is required it must be at least 20 characters long. +The `body` is mandatory for all commits except for those of type "docs". +When the body is present it must be at least 20 characters long and must conform to the [Commit Message Body](#commit-body) format. -The `footer` is optional. +The `footer` is optional. The [Commit Message Footer](#commit-footer) format describes what the footer is used for and the structure it must have. Any line of the commit message cannot be longer than 100 characters. @@ -321,7 +321,7 @@ Use the summary field to provide a succinct description of the change: * no dot (.) at the end -#### Commit Message Body +#### Commit Message Body Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes". @@ -329,7 +329,7 @@ Explain the motivation for the change in the commit message body. This commit me You can include a comparison of the previous behavior with the new behavior in order to illustrate the impact of the change. -#### Commit Message Footer +#### Commit Message Footer The footer can contain information about breaking changes and is also the place to reference GitHub issues, Jira tickets, and other PRs that this commit closes or is related to.