doc: clarify fixes and refs trailer guidance#64421
Open
trivikr wants to merge 1 commit into
Open
Conversation
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
Collaborator
|
Review requested:
|
UlisesGascon
approved these changes
Jul 11, 2026
aduh95
reviewed
Jul 11, 2026
Comment on lines
+189
to
+190
| 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. |
Contributor
There was a problem hiding this comment.
I don't understand this, I find it confusing, can you clarify or remove this? "landing manually" could mean several things, but no one should be hand-crafting commit messages that end up on main, they should be generated by NCU – and NCU adds the trailers if found in the PR description.
Suggested change
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The existing guidance is ambiguous: it first suggests adding
Fixes:andRefs:directly to the commit message, then says the landing toolingautomatically copies them from the pull request description.
This change clarifies that these trailers should normally be included in the
pull request description, avoiding unnecessary duplication. It also documents
the manual landing case and clarifies that the sample shows the final commit
message after landing.