doc: add note regarding commit message trailers · nodejs/node@b514438

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`