From 4319fbeff2c1809a210e9ff93f950be58da11172 Mon Sep 17 00:00:00 2001 From: Thomas De Schampheleire Date: Thu, 6 Mar 2014 11:07:35 +0100 Subject: [PATCH] manual: contributing: modify commit message template This patch updates the commit message template provided in the manual. The new template emphasizes the importance of providing a description of the problem, the root cause, and the solution, and the fact that all this should be wrapped at 72 characters. Suggested-by: "Yann E. MORIN" Signed-off-by: Thomas De Schampheleire Signed-off-by: Thomas Petazzoni --- docs/manual/contribute.txt | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt index 9eca69143a..52d4d04296 100644 --- a/docs/manual/contribute.txt +++ b/docs/manual/contribute.txt @@ -244,13 +244,20 @@ be preserved forever in the +git+ history of the project. Hereafter the recommended layout: --------------- -Patch title less than 80-character length +Patch title: short explanation, max 72 chars -A paragraph giving more details. +A paragraph that explains the problem, and how it manifests itself. If +the problem is complex, it is OK to add more paragraphs. All paragraphs +should be wrapped at 72 characters. -And yet another paragraph giving more details. +A paragraph that explains the root cause of the problem. Again, more +than on paragraph is OK. + +Finally, one or more paragraphs that explain how the problem is solved. +Don't hesitate to explain complex solutions in detail. + +Signed-off-by: John DOE -Signed-off-by: John Doe --- Changes v2 -> v3: - foo bar (suggested by Jane)