[Doc] Auto sign-off for VSCode (#20132)

Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
This commit is contained in:
Cyrus Leung
2025-06-26 23:18:36 +08:00
committed by GitHub
parent 0907d507bf
commit 6393b03986

View File

@ -152,9 +152,12 @@ the terms of the DCO.
Using `-s` with `git commit` will automatically add this header.
!!! tip
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.
Opening it will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`.
This ensures that all your commits are automatically signed-off by PyCharm.
You can enable automatic sign-off via your IDE:
- **PyCharm**: Click on the `Show Commit Options` icon to the right of the `Commit and Push...` button in the `Commit` window.
It will bring up a `git` window where you can modify the `Author` and enable `Sign-off commit`.
- **VSCode**: Open the [Settings editor](https://code.visualstudio.com/docs/configure/settings)
and enable the `Git: Always Sign Off` (`git.alwaysSignOff`) field.
### PR Title and Classification