Skip to content
Open
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions doc/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ to review changes that are split across multiple commits.

```bash
git add my/changed/files
git commit
git commit -s
```

Multiple commits often get squashed when they are landed. See the
Expand Down Expand Up @@ -206,6 +206,9 @@ A good commit message should describe what changed and why.
This rule does not apply to dependency updates (e.g. cherry-picks), release
commits, or backport commits.

[`git commit -s`][git commit -s] (with lowercase `s`) adds a
`Signed-off-by` trailer at the end of the commit log message.

Sample final commit message after landing:

```text
Expand Down Expand Up @@ -312,7 +315,7 @@ GitHub will automatically update the pull request.

```bash
git add my/changed/files
git commit
git commit -s
git push origin my-branch
```

Expand Down Expand Up @@ -617,6 +620,7 @@ More than one subsystem may be valid for any particular issue or pull request.
[approved]: #getting-approvals-for-your-pull-request
[benchmark results]: writing-and-running-benchmarks.md
[collaborator guide]: collaborator-guide.md
[git commit -s]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s
[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/
Expand Down
Loading