Skip to content

doc: add contributing detail for git Signed-off-by trailer - #64862

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
MikeMcC399:commit-signed-off-by-docs
Aug 2, 2026
Merged

doc: add contributing detail for git Signed-off-by trailer#64862
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
MikeMcC399:commit-signed-off-by-docs

Conversation

@MikeMcC399

@MikeMcC399 MikeMcC399 commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Fixes: #64799

Situation

The instructions under contributing > Pull requests > Commit message guidelines document section are formulated without reference to the git commit -s option which provides for assisted addition of the required Signed-off-by trailer:


  1. Your commit must contain the Signed-off-by line with your name and email
    address as an acknowledgement that you agree to the Developer Certificate of Origin.
    Bot generated commits are exempt from this requirement. If a commit has
    multiple authors, the Signed-off-by line should be added for each author;
    and at least one should match the author information in the commit metadata.
    This rule does not apply to dependency updates (e.g. cherry-picks), release
    commits, or backport commits.

The examples of git commit also do not show the use of the -s option.

It is however mentioned in the contributing > Guides and FAQs for first-time contributors > Going through the pull request review process

Change

Add instructions to contributing > Pull requests > Commit message guidelines for the git commit -s option.

Add the -s option to the existing git commit examples.

git commit -s, lower case s for Signed-off-by, could be confused with:

git commit -S, upper case S for --gpg-sign

so there is a note emphasising that lowercase s should be used.

@MikeMcC399 MikeMcC399 self-assigned this Jul 31, 2026
@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 the documentations. label Jul 31, 2026
@MikeMcC399

This comment was marked as outdated.

@MikeMcC399
MikeMcC399 marked this pull request as ready for review July 31, 2026 08:07
@MikeMcC399
MikeMcC399 force-pushed the commit-signed-off-by-docs branch from 71ce3c5 to c6e5ef2 Compare July 31, 2026 08:17
@MikeMcC399
MikeMcC399 marked this pull request as draft July 31, 2026 08:24
Add -s option to examples using git commit
Add description for git commit -s

Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
@MikeMcC399
MikeMcC399 force-pushed the commit-signed-off-by-docs branch from c6e5ef2 to 49ac4f8 Compare July 31, 2026 08:29
@MikeMcC399
MikeMcC399 marked this pull request as ready for review July 31, 2026 08:32
@MikeMcC399
MikeMcC399 requested a review from jasnell July 31, 2026 08:38

@bmuenzenmeyer bmuenzenmeyer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM - thanks for finding and fixing a real source of friction in the contributing process

@MikeMcC399

Copy link
Copy Markdown
Contributor Author

LGTM - thanks for finding and fixing a real source of friction in the contributing process

I only really noticed there was a documentation gap when I tried mentoring a first-time contributor!

@MikeMcC399 MikeMcC399 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 31, 2026
@MikeMcC399 MikeMcC399 added the commit-queue Add this label to land a pull request using GitHub Actions. label Jul 31, 2026
Comment thread doc/contributing/pull-requests.md
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 2, 2026
@nodejs-github-bot
nodejs-github-bot merged commit 0c87e08 into nodejs:main Aug 2, 2026
34 checks passed
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 0c87e08

@MikeMcC399
MikeMcC399 deleted the commit-signed-off-by-docs branch August 2, 2026 08:54
aduh95 pushed a commit that referenced this pull request Aug 3, 2026
Add -s option to examples using git commit
Add description for git commit -s

Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
PR-URL: #64862
Fixes: #64799
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
aduh95 pushed a commit that referenced this pull request Aug 4, 2026
Add -s option to examples using git commit
Add description for git commit -s

Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
PR-URL: #64862
Fixes: #64799
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
aduh95 pushed a commit that referenced this pull request Aug 4, 2026
Add -s option to examples using git commit
Add description for git commit -s

Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
PR-URL: #64862
Fixes: #64799
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
aduh95 pushed a commit that referenced this pull request Aug 5, 2026
Add -s option to examples using git commit
Add description for git commit -s

Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
PR-URL: #64862
Fixes: #64799
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
aduh95 pushed a commit that referenced this pull request Aug 6, 2026
Add -s option to examples using git commit
Add description for git commit -s

Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
PR-URL: #64862
Fixes: #64799
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: commit Signed-off-by instructions missing details

10 participants