diff options
| author | Jafar Al-Gharaibeh <Jafaral@users.noreply.github.com> | 2017-10-16 23:36:19 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-16 23:36:19 -0500 |
| commit | 2c38ed7789d4e8874b7a18cbc05114b0dccf247c (patch) | |
| tree | 33a07a1b214271b19c8150a4d53f17510048b262 | |
| parent | 5bf59faffcb266e5527d451c7486af71bac5fa21 (diff) | |
| parent | 53c2f1b73a33bc67dc95d79d48dfd7a78de2a245 (diff) | |
Merge pull request #1290 from qlyoung/doc-commit-msgs
doc: add docs for commit message format
| -rw-r--r-- | COMMUNITY.md | 17 |
1 files changed, 17 insertions, 0 deletions
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 |