NetCube-Systems-Austria/kumquat-buildroot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

manual: contributing: modify commit message template

Browse Source 
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" <yann.morin.1998@free.fr>
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
This commit is contained in:
Thomas De Schampheleire 2014-03-06 11:07:35 +01:00 committed by Thomas Petazzoni
parent 1c97e35f9b
commit 4319fbeff2
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/manual/contribute.txt
View File

@ -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 <john.doe@example.net>
Signed-off-by: John Doe <john.doe@noname.org>
---
Changes v2 -> v3:
- foo bar (suggested by Jane)