From d908eaf17fee569f3aab212f9f10674d89e4335c Mon Sep 17 00:00:00 2001 From: James M Snell Date: Thu, 26 Oct 2017 09:08:38 -0700 Subject: [PATCH 1/3] doc: slightly relax 50 character rule Allow commit message first line to exceed 50 chars if necessary --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c6de8d25498fe..f567383d6ee9c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -310,7 +310,9 @@ A good commit message should describe what changed and why. 1. The first line should: - contain a short description of the change - - be 50 characters or less + - be 50 characters or less (or as close as possible to 50 characters if it + is necessary to go over in order to provide a *useful* description of the + change) - be entirely in lowercase with the exception of proper nouns, acronyms, and the words that refer to code, like function/variable names - be prefixed with the name of the changed subsystem and start with an From 0da867161657f340c25b514d63431ca4d30f385c Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 27 Oct 2017 08:24:52 -0700 Subject: [PATCH 2/3] [Squash] Reword --- CONTRIBUTING.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f567383d6ee9c4..5f8b3b133ba4a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -309,10 +309,8 @@ notes about [commit squashing](#commit-squashing)). A good commit message should describe what changed and why. 1. The first line should: - - contain a short description of the change - - be 50 characters or less (or as close as possible to 50 characters if it - is necessary to go over in order to provide a *useful* description of the - change) + - contain a short description of the change (preferably 50 characters or less, + and absolutely no more than 72 characters) - be entirely in lowercase with the exception of proper nouns, acronyms, and the words that refer to code, like function/variable names - be prefixed with the name of the changed subsystem and start with an From 3664d77c660ad272c1662d4a1e9c42fa54dc06a7 Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 27 Oct 2017 11:43:17 -0700 Subject: [PATCH 3/3] [Squash] absolutely --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f8b3b133ba4a9..99278a843af683 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -310,7 +310,7 @@ A good commit message should describe what changed and why. 1. The first line should: - contain a short description of the change (preferably 50 characters or less, - and absolutely no more than 72 characters) + and no more than 72 characters) - be entirely in lowercase with the exception of proper nouns, acronyms, and the words that refer to code, like function/variable names - be prefixed with the name of the changed subsystem and start with an