Skip to content

doc: add note regarding commit message trailers #56736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 1 commit into from
Jan 26, 2025
Merged

doc: add note regarding commit message trailers #56736

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: add note regarding commit message trailers 
Co-authored-by: Yagiz Nizipli <yagiz@nizipli.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
  • Loading branch information
@dario-piotrowicz @anonrig @aduh95
3 people committed Jan 24, 2025
commit b8be8697128688ca71377ae7436519fa3dc96b19
5 changes: 5 additions & 0 deletions doc/contributing/pull-requests.md
View file
Open in desktop
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.

Comment thread
dario-piotrowicz marked this conversation as resolved.
Examples:

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