Skip to content

doc: correct typo in PR contribution instructions#62738

Merged
aduh95 merged 1 commit intonodejs:mainfrom
MikeMcC399:pr-contributing-typo
Apr 27, 2026
Merged

doc: correct typo in PR contribution instructions#62738
aduh95 merged 1 commit intonodejs:mainfrom
MikeMcC399:pr-contributing-typo

Conversation

@MikeMcC399
Copy link
Copy Markdown
Contributor

@MikeMcC399 MikeMcC399 commented Apr 14, 2026

This corrects a typo in doc/contributing/pull-requests.md as a test case to see if Signed-off-by metadata can be split across multiple lines according to https://git-scm.com/docs/git-interpret-trailers

Edit: At the moment, this does not work. Leaving this PR open as a test subject.

Signed-off-by: Mike McCready
  <66998419+MikeMcC399@users.noreply.github.com>
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 14, 2026
@MikeMcC399 MikeMcC399 marked this pull request as ready for review April 14, 2026 15:26
@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/tsc

@MikeMcC399

This comment was marked as outdated.

@lpinca lpinca added the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 16, 2026
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Apr 16, 2026
@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/62738
✔  Done loading data for nodejs/node/pull/62738
----------------------------------- PR info ------------------------------------
Title      doc: correct typo in PR contribution instructions (#62738)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     MikeMcC399:pr-contributing-typo -> nodejs:main
Labels     doc
Commits    1
 - doc: correct typo in PR contribution instructions
Committers 1
 - Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
PR-URL: https://github.com/nodejs/node/pull/62738
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Richard Lau <richard.lau@ibm.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/62738
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Richard Lau <richard.lau@ibm.com>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Tue, 14 Apr 2026 15:25:12 GMT
   ✔  Approvals: 6
   ✔  - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/62738#pullrequestreview-4107300636
   ✔  - Rafael Gonzaga (@RafaelGSS) (TSC): https://github.com/nodejs/node/pull/62738#pullrequestreview-4107536653
   ✔  - Filip Skokan (@panva) (TSC): https://github.com/nodejs/node/pull/62738#pullrequestreview-4107705842
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/62738#pullrequestreview-4108589357
   ✔  - Marco Ippolito (@marco-ippolito) (TSC): https://github.com/nodejs/node/pull/62738#pullrequestreview-4109162335
   ✔  - Richard Lau (@richardlau) (TSC): https://github.com/nodejs/node/pull/62738#pullrequestreview-4109367285
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 62738
From https://github.com/nodejs/node
 * branch                  refs/pull/62738/merge -> FETCH_HEAD
✔  Fetched commits as 2071c446309e..e4a1934c14c2
--------------------------------------------------------------------------------
[main 2bffc82c34] doc: correct typo in PR contribution instructions
 Author: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
 Date: Tue Apr 14 17:23:08 2026 +0200
 1 file changed, 1 insertion(+), 1 deletion(-)
   ✔  Patches applied
--------------------------------------------------------------------------------
--------------------------------- New Message ----------------------------------
doc: correct typo in PR contribution instructions

<66998419+MikeMcC399@users.noreply.github.com>

Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
PR-URL: #62738
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Richard Lau <richard.lau@ibm.com>

[main adaacc2b52] doc: correct typo in PR contribution instructions
Author: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Date: Tue Apr 14 17:23:08 2026 +0200
1 file changed, 1 insertion(+), 1 deletion(-)
✖ adaacc2b529a1279e0fedf70656c0c41d4378180
✔ 0:0 no Co-authored-by metadata co-authored-by-is-trailer
✔ 0:0 skipping fixes-url fixes-url
✔ 0:0 blank line after title line-after-title
✖ 3:72 Line should be <= 72 columns. line-length
✔ 0:0 metadata is at end of message metadata-end
✔ 4:8 PR-URL is valid. pr-url
✔ 0:0 reviewers are valid reviewers
✔ 0:0 valid subsystems subsystem
✔ 0:0 Title is formatted correctly. title-format
✔ 0:0 Title is <= 50 columns. title-length

ℹ Please fix the commit message and try again.
Please manually ammend the commit message, by running
git commit --amend
Once commit message is fixed, finish the landing command running
git node land --continue

https://github.com/nodejs/node/actions/runs/24531509406

@MikeMcC399
Copy link
Copy Markdown
Contributor Author

MikeMcC399 commented Apr 16, 2026

Fails due to

✖ 3:72 Line should be <= 72 columns. line-length

See related tooling fix proposals mentioned in #62577 (comment):

@MikeMcC399

This comment was marked as resolved.

Copy link
Copy Markdown
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change to the commit validation tool also LGTM.

@MikeMcC399
Copy link
Copy Markdown
Contributor Author

MikeMcC399 commented Apr 27, 2026

Commit now fails differently with

Error: not ok 6 signed-off-by: "Signed-off-by" trailer has invalid email (Signed-off-by: Mike McCready)
  ---
    {
      found: 'Signed-off-by: Mike McCready',
      compare: '===',
      wanted: '',
      at: {
        line: 1,
        column: 0,
        body: [
          '',
          'Signed-off-by: Mike McCready',
          '  <66998419+MikeMcC399@users.noreply.github.com>'
        ]
      }
    }
  ...

Waiting for nodejs/node-core-utils#1062 to be released.

This is waiting for nodejs/node-core-utils#1064 which is failing in CI because it is trying to test against the unavailable Node.js v26, based on using the original release date of 2026-04-22 that hasn't been updated in schedule.json, nor in replicates of it. Edit: this was released as https://github.com/nodejs/node-core-utils/releases/tag/v6.3.3

@MikeMcC399 MikeMcC399 force-pushed the pr-contributing-typo branch from 850432a to ef67811 Compare April 27, 2026 08:46
@MikeMcC399
Copy link
Copy Markdown
Contributor Author

Changed to single line

Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

in commit message, which passes "First commit message adheres to guidelines" test.

@aduh95
Copy link
Copy Markdown
Contributor

aduh95 commented Apr 27, 2026

@MikeMcC399 could we try to put it back to two lines to make sure the tooling correctly accepts it?

EDIT: Ah I missed #62738 (comment), nevermind; still, I want to see if the tooling supports it, I'll be landing the original commit from the CLI

@aduh95 aduh95 force-pushed the pr-contributing-typo branch 2 times, most recently from 850432a to e4a1934 Compare April 27, 2026 09:19
@aduh95 aduh95 merged commit bb85d23 into nodejs:main Apr 27, 2026
55 of 56 checks passed
@aduh95
Copy link
Copy Markdown
Contributor

aduh95 commented Apr 27, 2026

Landed in bb85d23

@MikeMcC399 MikeMcC399 deleted the pr-contributing-typo branch April 27, 2026 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

commit-queue-failed An error occurred while landing this pull request using GitHub Actions. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants