Skip to content

doc: clarify fixes and refs trailer guidance #64421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
trivikr wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −8
Open

doc: clarify fixes and refs trailer guidance #64421

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b179a68
doc: clarify fixes and refs trailer guidance
trivikr Jul 11, 2026
7c8d9d8
fixup! doc: remove manual landing portion
trivikr Jul 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions doc/contributing/pull-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,14 +180,13 @@ 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.

Examples:

Expand All @@ -207,7 +206,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
Expand Down
Loading