doc: add note regarding commit message trailers

Co-authored-by: Yagiz Nizipli <[email protected]> Co-authored-by: Antoine du Hamel <[email protected]> PR-URL: #56736 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Jan 30, 2025 · 38acdb5 · 38acdb5
1 parent 59510ab
commit 38acdb5
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/contributing/pull-requests.md b/doc/contributing/pull-requests.md
@@ -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`