Skip to content

Commit b179a68

Browse files
committed
doc: clarify fixes and refs trailer guidance
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
1 parent 6eff679 commit b179a68

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

doc/contributing/pull-requests.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -180,14 +180,14 @@ A good commit message should describe what changed and why.
180180

181181
3. Wrap all other lines at 72 columns (except for long URLs).
182182

183-
4. If your patch fixes an open issue, you can add a reference to it at the end
184-
of the log. Use the `Fixes:` prefix and the full issue URL. For other
185-
references use `Refs:`.
183+
4. If your patch fixes an open issue, include a reference in the pull request
184+
description. Use the `Fixes:` prefix and the full issue URL. For other
185+
references, use `Refs:`.
186186

187-
`Fixes:` and `Refs:` trailers get automatically added to your commit message
188-
when the Pull Request lands as long as they are included in the
189-
Pull Request's description. If the Pull Request lands in several commits,
190-
by default the trailers found in the description are added to each commits.
187+
`Fixes:` and `Refs:` trailers are automatically added to the commit message
188+
when the pull request lands. If the pull request lands as several commits,
189+
the trailers from the description are added to each commit by default. When
190+
landing the pull request manually, add the trailers to the commit message.
191191

192192
Examples:
193193

@@ -207,7 +207,7 @@ A good commit message should describe what changed and why.
207207
This rule does not apply to dependency updates (e.g. cherry-picks), release
208208
commits, or backport commits.
209209

210-
Sample complete commit message:
210+
Sample final commit message after landing:
211211

212212
```text
213213
subsystem: explain the commit in one line

0 commit comments

Comments
 (0)