mirror of
https://github.com/nodejs/node.git
synced 2026-10-28 10:15:07 +08:00
doc: add contributing detail for git Signed-off-by trailer
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: https://github.com/nodejs/node/pull/64862 Fixes: https://github.com/nodejs/node/issues/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>
This commit is contained in:
1 parent
7828f2e173
commit
0c87e08621
1 file changed
+6
-2
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
```
|
||||
|
||||
@@ -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/
|
||||
|
||||
Reference in new issue
Block a user