Docs: Add Conventional Commit specification links

While creating a Current Best Practices presentation for some Computer
Science students I stumbled upon references to Semantic Commit Messages.

Upon further reading on the subject I believe that this is a new
practice that we should be recommending to communities. There seems to
be a rabbit hole of references on it, so I'm only recommending the two
that seem to give the best results. In particular the Gist has continued
discussion even after the initial posting on May 15, 2017.

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

diff --git a/docs/best-practices.rst b/docs/best-practices.rst
index 3985908..8c4c267 100644 (file)
--- a/docs/best-practices.rst
+++ b/docs/best-practices.rst
@@ -23,6 +23,9 @@ that they are not hitting any of these):
 - Does the Git commit message sufficiently describes the change?
   (Refer to: https://chris.beams.io/posts/git-commit/ and
   https://fatbusinessman.com/2019/my-favourite-git-commit)
+- Does the Git commit subject line follow the Conventional Commit specification?
+  (Refer to: https://www.conventionalcommits.org/ and
+  https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716)
 - Does the commit message have an 'Issue: <someissue>' in the footer and not
   in the subject line or body?
 - Are there any typos?