From ed3ed8db2e331a63d06a757e16af5d7d2930bd63 Mon Sep 17 00:00:00 2001 From: Quentin Schulz Date: Thu, 18 Sep 2025 12:24:40 +0200 Subject: 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: a5862406bf3230befe9db9f2539bbbc86c02015d) Signed-off-by: Quentin Schulz Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/contributor-guide/submit-changes.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'documentation/contributor-guide/submit-changes.rst') diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index e1215a5550..35da2dbc70 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 -- cgit v1.2.3-54-g00ecf