diff mbox series

[2/7] contributor-guide: submit-changes: clarify example with Yocto bug ID

Message ID 20250918-submit-patches-v1-2-28abd2919df0@cherry.de
State Under Review
Headers show
Series contributor-guide: submit-changes: improve instructions on commit content | expand

Commit Message

Quentin Schulz Sept. 18, 2025, 10:24 a.m. UTC 
From: Quentin Schulz <quentin.schulz@cherry.de>

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 <barne.carstensen@danfoss.com>
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 documentation/contributor-guide/submit-changes.rst | 2 ++
 1 file changed, 2 insertions(+)
diff mbox series

Patch

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index e1215a5550f03f780da6478076d665bfe60c0641..35da2dbc70d402eb5b8c6ed450e12f46bb7fcede 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