8000 meta: add requirement for signed-off-by statements by jasnell · Pull Request #31976 · nodejs/node · GitHub
[go: up one dir, main page]
Skip to content

meta: add requirement for signed-off-by statements #31976

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

Closed
jasnell wants to merge 1 commit into from
Closed

meta: add requirement for signed-off-by statements #31976

Show file tree
Hide file tree
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
4 changes: 4 additions & 0 deletions COLLABORATOR_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,6 +591,10 @@ for that commit. This is an opportunity to fix commit messages.
reviewed the change.
* Useful for @mentions / contact list if something goes wrong in the PR.
* Protects against the assumption that GitHub will be around forever.
* Required: A `Signed-off-by: Name <email>` line for each individual who
contributed to the commit. Commit authors should add these lines themselves.
Collaborators may add them while landing if the author agrees in the PR
discussion.

Other changes may have landed on master since the successful CI run. As a
precaution, run tests (`make -j4 test` or `vcbuild test`).
Expand Down
25 changes: 24 additions & 1 deletion doc/guides/contributing/pull-reque 10000 sts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ so that you can make the actual changes. This is where we will start.
* [The Process of Making Changes](#the-process-of-making-changes)
* [Step 3: Code](#step-3-code)
* [Step 4: Commit](#step-4-commit)
* [Signing off on commits](#signing-off-on-commits)
* [Commit message guidelines](#commit-message-guidelines)
* [Step 5: Rebase](#step-5-rebase)
* [Step 6: Test](#step-6-test)
Expand Down Expand Up @@ -134,12 +135,32 @@ to review changes that are split across multiple commits.

```text
$ git add my/changed/files
$ git commit
$ git commit -s
```

Multiple commits often get squashed when they are landed. See the
notes about [commit squashing](#commit-squashing).

#### Signing off on commits

All commits landed must contain one `Signed-off-by` metadata statement for
each author. The value of this statement must
match the name and email address configured in [Step 1][].

```text
Signed-off-by: J. Random User <j.random.user@example.com>
```

To add the `Signed-off-by` statement with `git`, use the `-s` (or `--signoff`)
option:

```text
$ git commit -s
```

Sign-off indicates that the commit complies with
[Developer's Certificate of Origin 1.1][].

#### Commit message guidelines

A good commit message should describe what changed and why.
Expand Down Expand Up @@ -587,9 +608,11 @@ If you want to know more about the code review and the landing process, see the
[CI (Continuous Integration) test run]: #ci-testing
[Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md
[Collaborator Guide]: ../../../COLLABORATOR_GUIDE.md
[Developer's Certificate of Origin 1.1]: ../../../CONTRIBUTING.md#developers-certificate-of-origin
[guide for writing tests in Node.js]: ../writing-tests.md
[hiding-a-comment]: https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment
[https://ci.nodejs.org/]: https://ci.nodejs.org/
[IRC in the #node-dev channel]: https://webchat.freenode.net?channels=node-dev&uio=d4
[Onboarding guide]: ../../onboarding.md
[running tests]: ../../../BUILDING.md#running-tests
[Step 1]: #step-1-fork
0