From 3df4f464d80fed7199bb2ec31081eb53664c711d Mon Sep 17 00:00:00 2001 From: Guillaume Lambert Date: Fri, 7 May 2021 15:48:10 +0200 Subject: [PATCH] Docs: Improve best practices content - fix a typo - make conventional commit format use optional - precise first paragraph content - mention ChangeLog Signed-off-by: Guillaume Lambert Change-Id: I891b6aa55bdde69a605aa35e84af3d5e7506b5ba --- docs/best-practices.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/best-practices.rst b/docs/best-practices.rst index 8c4c267..6d8c3dd 100644 --- a/docs/best-practices.rst +++ b/docs/best-practices.rst @@ -20,19 +20,25 @@ that they are not hitting any of these): **General** -- Does the Git commit message sufficiently describes the change? +- Does the Git commit message sufficiently describe 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 +- Does the Git commit subject line need to 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: ' in the footer and not - in the subject line or body? +- If the change has an associated issue tracker, does the commit message have an + 'Issue: ' (or any similar tag such as 'Issue-Id:' or 'JIRA:') in + the footer and not in the subject line or body? - Are there any typos? - Are all code review comments addressed? - Is the code rebased onto the latest HEAD of the branch? - Does the code pull in any dependencies that might have license conflicts with this project's license? +- Is the Git commit body independent from the title ? + The first paragraph should not be a continued flow from the subject line + but a paragraph that can stand on its own. +- If important changes are brought by the commit(s), does an appropriate + ChangeLog file need to be created ? (for example a reno YAML file for Releng) **Code** -- 2.16.6