Docs: Add statement about meta-data handling

Several contributors have been unclear on guidance around meta-data
handling in commit messages. Instead of expecting folks to grok it from
linked documentation and examples, it's better to be explicit.

Change-Id: Ia0411eb9e1b54c4d1ff3863bd428124809856329
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>

diff --git a/docs/best-practices.rst b/docs/best-practices.rst
index 6d8c3dd..6e4e5a5 100644 (file)
--- a/docs/best-practices.rst
+++ b/docs/best-practices.rst
@@ -29,6 +29,9 @@ that they are not hitting any of these):
 - If the change has an associated issue tracker, does the commit message have an
   'Issue: <someissue>' (or any similar tag such as 'Issue-Id:' or 'JIRA:') in
   the footer and not in the subject line or body?
+- Is *all* meta-data in the footer? This includes the above point and any other
+  key-value data pairings that are truly meta-data. Such as, but not limited to,
+  Signed-off-by, Change-Id, Issue, Jira, Issue-Id, Bug, etc.
 - Are there any typos?
 - Are all code review comments addressed?
 - Is the code rebased onto the latest HEAD of the branch?