From b179a68ca2e792ee7020f97776f28ad322a92528 Mon Sep 17 00:00:00 2001 From: "Kamat, Trivikram" <16024985+trivikr@users.noreply.github.com> Date: Sat, 11 Jul 2026 00:22:03 -0700 Subject: [PATCH 1/2] doc: clarify fixes and refs trailer guidance Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com> --- doc/contributing/pull-requests.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/contributing/pull-requests.md b/doc/contributing/pull-requests.md index 7215c2440a8441..39c60ce45c62fe 100644 --- a/doc/contributing/pull-requests.md +++ b/doc/contributing/pull-requests.md @@ -180,14 +180,14 @@ A good commit message should describe what changed and why. 3. Wrap all other lines at 72 columns (except for long URLs). -4. If your patch fixes an open issue, you can add a reference to it at the end - of the log. Use the `Fixes:` prefix and the full issue URL. For other - references use `Refs:`. +4. If your patch fixes an open issue, include a reference in the pull request + description. Use the `Fixes:` prefix and the full issue URL. For other + references, use `Refs:`. - `Fixes:` and `Refs:` trailers get automatically added to your commit message - when the Pull Request lands as long as they are included in the - Pull Request's description. If the Pull Request lands in several commits, - by default the trailers found in the description are added to each commits. + `Fixes:` and `Refs:` trailers are automatically added to the commit message + when the pull request lands. If the pull request lands as several commits, + the trailers from the description are added to each commit by default. When + landing the pull request manually, add the trailers to the commit message. Examples: @@ -207,7 +207,7 @@ A good commit message should describe what changed and why. This rule does not apply to dependency updates (e.g. cherry-picks), release commits, or backport commits. -Sample complete commit message: +Sample final commit message after landing: ```text subsystem: explain the commit in one line From 7c8d9d880beec67888b7fc485cdaf6d4b5499f35 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Sat, 11 Jul 2026 10:16:55 -0700 Subject: [PATCH 2/2] fixup! doc: remove manual landing portion Co-authored-by: Antoine du Hamel --- doc/contributing/pull-requests.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/contributing/pull-requests.md b/doc/contributing/pull-requests.md index 39c60ce45c62fe..def629c14933f1 100644 --- a/doc/contributing/pull-requests.md +++ b/doc/contributing/pull-requests.md @@ -186,8 +186,7 @@ A good commit message should describe what changed and why. `Fixes:` and `Refs:` trailers are automatically added to the commit message when the pull request lands. If the pull request lands as several commits, - the trailers from the description are added to each commit by default. When - landing the pull request manually, add the trailers to the commit message. + the trailers from the description are added to each commit by default. Examples: