]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: add docs for commit message format 1290/head
authorQuentin Young <qlyoung@cumulusnetworks.com>
Wed, 4 Oct 2017 19:41:34 +0000 (15:41 -0400)
committerQuentin Young <qlyoung@cumulusnetworks.com>
Wed, 4 Oct 2017 19:41:34 +0000 (15:41 -0400)
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
COMMUNITY.md

index bbc5bb6d1050494f677f5630f900baf43d1ee296..5bc95ddcc826f9023071fbd3f4fbb0d71416245c 100644 (file)
@@ -222,6 +222,23 @@ merged in a timely manner.
 
 ## Developer's Guidelines
 
+### Commit messages
+
+Commit messages should be formatted in the same way as Linux kernel commit
+messages. The format is roughly
+
+``` dir: short summary
+
+extended summary ```
+
+`dir` should be the top level source directory under which the change was made.
+For example, a change in bgpd/rfapi would be formatted as:
+
+`bgpd: short summary`
+
+The first line should be no longer than 50 characters. Subsequent lines should
+be wrapped to 72 characters.
+
 ### Source file header
 
 New files need to have a Copyright header (see [License for