GeezerVison is showing github.com — doc: add contributing detail for git Signed-off-by trailer · nodejs/node@5604e4e
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: doc/contributing/pull-requests.md +6-2Lines changed: 6 additions & 2 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -151,7 +151,7 @@ to review changes that are split across multiple commits. |
151 | 151 |
|
152 | 152 | ```bash |
153 | 153 | git add my/changed/files |
154 | | -git commit |
| 154 | +git commit -s |
155 | 155 | ``` |
156 | 156 |
|
157 | 157 | Multiple commits often get squashed when they are landed. See the |
@@ -206,6 +206,9 @@ A good commit message should describe what changed and why. |
206 | 206 | This rule does not apply to dependency updates (e.g. cherry-picks), release |
207 | 207 | commits, or backport commits. |
208 | 208 |
|
| 209 | + [`git commit -s`][git commit -s] (with lowercase `s`) adds a |
| 210 | + `Signed-off-by` trailer at the end of the commit log message. |
| 211 | + |
209 | 212 | Sample final commit message after landing: |
210 | 213 |
|
211 | 214 | ```text |
@@ -312,7 +315,7 @@ GitHub will automatically update the pull request. |
312 | 315 |
|
313 | 316 | ```bash |
314 | 317 | git add my/changed/files |
315 | | -git commit |
| 318 | +git commit -s |
316 | 319 | git push origin my-branch |
317 | 320 | ``` |
318 | 321 |
|
@@ -617,6 +620,7 @@ More than one subsystem may be valid for any particular issue or pull request. |
617 | 620 | [approved]: #getting-approvals-for-your-pull-request |
618 | 621 | [benchmark results]: writing-and-running-benchmarks.md |
619 | 622 | [collaborator guide]: collaborator-guide.md |
| 623 | +[git commit -s]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s |
620 | 624 | [guide for writing tests in Node.js]: writing-tests.md |
621 | 625 | [hiding-a-comment]: https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment |
622 | 626 | [https://ci.nodejs.org/]: https://ci.nodejs.org/ |
|