You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@
18
18
## Before your PR is "*Ready for review*"
19
19
<!-- If you haven't finished some of the above items you can still open `Draft` PR. -->
20
20
21
-
-**Make sure you read and follow [Contributor guidelines](https://github.com/NVIDIA/TensorRT-Model-Optimizer/blob/main/CONTRIBUTING.md)**
21
+
-**Make sure you read and follow [Contributor guidelines](https://github.com/NVIDIA/TensorRT-Model-Optimizer/blob/main/CONTRIBUTING.md)** and your commits are signed.
22
22
-**Is this change backward compatible?**: Yes/No <!--- If No, explain why. -->
23
23
-**Did you write any new necessary tests?**: Yes/No
24
24
-**Did you add or update any necessary documentation?**: Yes/No
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original
76
76
work, or you have rights to submit it under the same license, or a compatible license.
77
77
78
-
- You need to sign-off your commits using an GPG / SSH key which is different than the one used for authentication. See [GitHub docs](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) for more details.
78
+
- You need to cryptographically sign-off your commits as well using an SSH/GPG key which is different than the one used for authentication. See [GitHub docs](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) for more details. Note that setting up the SSH key is much simpler than the GPG key hence recommended to use SSH signing key following the steps below (requires `git>=2.34`).
79
79
80
-
- Any contribution which contains commits that are not Signed-Off will not be accepted.
80
+
- Generate a new SSH key as per steps [in this doc](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key). For example:
81
81
82
-
- To sign off on a commit you simply use the `--signoff --gpg-sign` (or `-s -S`) option when committing your changes:
- Upload the public key (`cat "${HOME}/.ssh/id_ed25519_git_signing.pub"`) as a new SSH key in your [GitHub settings](https://github.com/settings/ssh/new) with an appropriate title and selectkeytype as `Signing Key`.
87
+
88
+
- Configure your local`git` to use the new SSH key for signing commits:
- **Any contribution which contains commits that are not Signed-Off will not be accepted**.
97
+
98
+
- Once you have set up your SSH/GPG key, to sign off on a commit you simply use the `--signoff --gpg-sign` (or `-s -S`) option when committing your changes:
83
99
84
100
```bash
85
101
git commit -s -S -m "Add cool feature."
86
102
```
87
103
104
+
>*TIP: To enable this forcommittingin VSCode, you can enable`git.alwaysSignOff` and `git.enableCommitSigning`in your VSCode settings (`Ctrl/Cmd + ,`).*
105
+
88
106
This will append the following to your commit message:
0 commit comments