From 505c22627712d75733133fcefa8aa77280dce64f Mon Sep 17 00:00:00 2001 From: Ajit Singh Date: Sun, 19 Jul 2020 19:39:45 +0530 Subject: [PATCH] docs: small changes to contibting.md maximum length of commit message line can be 120 characters intead of 100. Fixes lines should come before BREAKING CHANGE blocks. Otherwise they become part of the breaking change notice. --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ec3a41f0af1..bf3ef0987ff1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -197,7 +197,7 @@ When the body is required it must be at least 20 characters long. The `footer` is optional. -Any line of the commit message cannot be longer than 100 characters. +Any line of the commit message cannot be longer than 120 characters. #### Commit Message Header @@ -302,12 +302,13 @@ You can include a comparison of the previous behavior with the new behavior in o 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. ``` +Fixes # + BREAKING CHANGE: -Fixes # ``` Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of the breaking change, a blank line, and a detailed description of the breaking change that also includes migration instructions.