From 860a44ec997686b2d88ff2fd5ee0d582bdb74d77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Boulle?= Date: Fri, 21 Aug 2020 13:38:25 +0200 Subject: [PATCH] docs(readme): add the optional status of body and footer --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 45e18e2..3f9fdf2 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ The header has a special format that includes a **type**, a **scope** and a **su - The first line of the commit message (the "Subject") cannot be longer than 70 characters. - Any other line of the commit message cannot be longer 100 characters! +- The body and footer are optional, but depends on the type some information can be mandatory. This allows the message to be easier to read on github as well as in various git tools. @@ -97,11 +98,15 @@ Here are some recommandation for writing your subject: ### Body The body should include the motivation for the change and contrast this with previous behavior. +It is optional but highly recommended for any impacting changes. ### Footer The footer should contain any information about **Breaking Changes** and is also the place to reference JIRA ticket related to this commit. + +The footer is optional but for **feat** and **fix** type the JIRA reference is mandatory. + The breaking changes must be at the end of the commit with only "BROKEN:" before the list of breaking changes. They must be each on a new line.