From 53c2f1b73a33bc67dc95d79d48dfd7a78de2a245 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 4 Oct 2017 15:41:34 -0400 Subject: [PATCH] doc: add docs for commit message format Signed-off-by: Quentin Young --- COMMUNITY.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/COMMUNITY.md b/COMMUNITY.md index bbc5bb6d10..5bc95ddcc8 100644 --- a/COMMUNITY.md +++ b/COMMUNITY.md @@ -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 -- 2.39.5