From d153a3dc36d8e53f4479e0480a0bd9506e3f1844 Mon Sep 17 00:00:00 2001 From: Quentin Schulz Date: Thu, 18 Sep 2025 12:24:40 +0200 Subject: [PATCH] contributor-guide: submit-changes: clarify example with Yocto bug ID The example could be understood as the content of the commit message once the editor (git config core.editor) opens, where the first line is the actual commit title and not the commit description. This example would make the Fixes line the commit title, which is not what we want. In short, according to my understanding of git-commit(1): The following is a git commit message: """ git commit title git commit description """ Reported-by: Barne Carstensen (From yocto-docs rev: db54a8bd56f38c532498e0f624fcceb60d2b9ea7) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard (cherry picked from commit a5862406bf3230befe9db9f2539bbbc86c02015d) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/contributor-guide/submit-changes.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index 551911aced..52c08faafe 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -198,6 +198,8 @@ to add the upgraded version. description. Be sure to use the actual bug-tracking ID from Bugzilla for bug-id:: + single-line summary of change + Fixes [YOCTO #bug-id] detailed description of change