From: Andrew Grimberg Date: Mon, 21 Oct 2019 19:16:33 +0000 (-0700) Subject: Add additional reading about good git messages X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=8254a5c76cf7f49737f56b1e35064d6a65e5c9bb;p=releng%2Fdocs.git Add additional reading about good git messages Since we like to give as many sources of good content as possible when it comes to commit messages, another blog post was recently written and brought brought to my attention. It's got additional links to some more good content. In this case it goes into detail on what a really good message looks like, why it's good. For instance, it explains the reason behind the change and all the work done to implement it along with giving learning examples. Change-Id: Id4fef32e15beededb6c13197d8e85922c5e808a9 Signed-off-by: Andrew Grimberg --- diff --git a/docs/best-practices.rst b/docs/best-practices.rst index fb8e59b..2a378e6 100644 --- a/docs/best-practices.rst +++ b/docs/best-practices.rst @@ -21,7 +21,8 @@ that they are not hitting any of these): **General** - Does the Git commit message sufficiently describes the change? - (Refer to: https://chris.beams.io/posts/git-commit/) + (Refer to: https://chris.beams.io/posts/git-commit/ and + https://fatbusinessman.com/2019/my-favourite-git-commit) - Does the commit message have an 'Issue: ' in the footer and not in the subject line or body? - Are there any typos?