doc: add contributing detail for git Signed-off-by trailer - #64862
Open
MikeMcC399 wants to merge 1 commit into
Open
doc: add contributing detail for git Signed-off-by trailer#64862MikeMcC399 wants to merge 1 commit into
MikeMcC399 wants to merge 1 commit into
Conversation
Collaborator
|
Review requested:
|
Contributor
Author
MikeMcC399
marked this pull request as ready for review
July 31, 2026 08:07
MikeMcC399
force-pushed
the
commit-signed-off-by-docs
branch
from
July 31, 2026 08:17
71ce3c5 to
c6e5ef2
Compare
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
force-pushed
the
commit-signed-off-by-docs
branch
from
July 31, 2026 08:29
c6e5ef2 to
49ac4f8
Compare
MikeMcC399
marked this pull request as ready for review
July 31, 2026 08:32
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: #64799
Situation
The instructions under contributing > Pull requests > Commit message guidelines document section are formulated without reference to the
git commit -soption which provides for assisted addition of the requiredSigned-off-bytrailer:Signed-off-byline with your name and emailaddress 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-byline 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 commitalso do not show the use of the-soption.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 -soption.Add the
-soption to the existinggit commitexamples.