Skip to content

Commit

Permalink
doc: add note regarding commit message trailers
Browse files Browse the repository at this point in the history
Co-authored-by: Yagiz Nizipli <[email protected]>
Co-authored-by: Antoine du Hamel <[email protected]>
  • Loading branch information
3 people committed Jan 24, 2025
1 parent da5f7ac commit b8be869
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,11 @@ A good commit message should describe what changed and why.
of the log. 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.

Examples:

* `Fixes: https://github.com/nodejs/node/issues/1337`
Expand Down

0 comments on commit b8be869

Please sign in to comment.