Skip to content

Commit 6393b03

Browse files
[Doc] Auto sign-off for VSCode (#20132)
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
1 parent 0907d50 commit 6393b03

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/contributing/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,12 @@ the terms of the DCO.
152152
Using `-s` with `git commit` will automatically add this header.
153153

154154
!!! tip
155-
If you develop using PyCharm, there is a `Show Commit Options` icon to the right of the `Commit and Push...` button in the `Commit` window.
156-
Opening it will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`.
157-
This ensures that all your commits are automatically signed-off by PyCharm.
155+
You can enable automatic sign-off via your IDE:
156+
157+
- **PyCharm**: Click on the `Show Commit Options` icon to the right of the `Commit and Push...` button in the `Commit` window.
158+
It will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`.
159+
- **VSCode**: Open the [Settings editor](https://code.visualstudio.com/docs/configure/settings)
160+
and enable the `Git: Always Sign Off` (`git.alwaysSignOff`) field.
158161

159162
### PR Title and Classification
160163

0 commit comments

Comments
 (0)