Skip to content

doc: clarify fixes and refs trailer guidance - #64421

Merged
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
trivikr:doc-commit-body-refs
Jul 13, 2026
Merged

doc: clarify fixes and refs trailer guidance#64421
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
trivikr:doc-commit-body-refs

Conversation

@trivikr

@trivikr trivikr commented Jul 11, 2026

Copy link
Copy Markdown
Member

The existing guidance is ambiguous: it first suggests adding Fixes: and
Refs: directly to the commit message, then says the landing tooling
automatically copies them from the pull request description.

This change clarifies that these trailers should normally be included in the
pull request description, avoiding unnecessary duplication. It also documents
the manual landing case and clarifies that the sample shows the final commit
message after landing.

Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Jul 11, 2026
Comment thread doc/contributing/pull-requests.md Outdated
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@trivikr
trivikr requested a review from aduh95 July 11, 2026 17:18
@trivikr trivikr added author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue-rebase PRs the Commit Queue should land as multiple self-contained commits. commit-queue PRs queued for automated landing through the Commit Queue. commit-queue-squash PRs the Commit Queue should land as one squashed commit. and removed commit-queue-rebase PRs the Commit Queue should land as multiple self-contained commits. labels Jul 11, 2026
@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Jul 13, 2026
@nodejs-github-bot
nodejs-github-bot merged commit e631709 into nodejs:main Jul 13, 2026
31 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in e631709

aduh95 pushed a commit that referenced this pull request Jul 21, 2026
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
PR-URL: #64421
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
aduh95 pushed a commit that referenced this pull request Jul 21, 2026
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
PR-URL: #64421
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
RafaelGSS pushed a commit that referenced this pull request Jul 29, 2026
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
PR-URL: #64421
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@trivikr
trivikr deleted the doc-commit-body-refs branch July 31, 2026 04:31
aduh95 pushed a commit that referenced this pull request Aug 6, 2026
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
PR-URL: #64421
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue-squash PRs the Commit Queue should land as one squashed commit. doc Issues and PRs related to Node.js documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants