From a04f4d2fdfc61051ce1a8b1433cc9696012b9386 Mon Sep 17 00:00:00 2001 From: Eduardo Almeida Date: Thu, 12 Sep 2024 22:06:34 +0100 Subject: [PATCH] Update Git commit message guidelines in CONTRIBUTING.md --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 846f7a11a..8470c4b22 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -160,10 +160,11 @@ While the prerequisites above must be satisfied prior to having your merge reque ### Git Commit Messages -* Use the present tense ("Add feature" not "Added feature") -* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") +* Use the present tense (e.g., "Add feature" not "Added feature") +* Use the imperative mood (e.g., "Move cursor to..." not "Moves cursor to...") * Limit the first line to 72 characters or less -* Reference issues in the first line, by prepending `[#issue]` +* Reference the modules edited in the commit, except if the change applies to many modules (e.g., "core, network: ...") +* If a commit fixes an issue, add "(fixes #issue)" to the commit message (e.g., "core: (fixes #issue) ...") ### C++ Styleguide