Skip to content

Commit

Permalink
doc: clarify that PR commit Fixes: and Refs: are optional
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 91efab6
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion 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 Expand Up @@ -594,4 +599,4 @@ More than one subsystem may be valid for any particular issue or pull request.
[maintaining dependencies]: ./maintaining/maintaining-dependencies.md
[nodejs/core-validate-commit]: https://github.com/nodejs/core-validate-commit/blob/main/lib/rules/subsystem.js
[pull request template]: https://raw.githubusercontent.com/nodejs/node/HEAD/.github/PULL_REQUEST_TEMPLATE.md
[running tests]: ../../BUILDING.md#running-tests
[running tests]: ../../BUILDING.md#running-tests

0 comments on commit 91efab6

Please sign in to comment.