From 6393b039865b35c79c5c397e5dca0218d3c26622 Mon Sep 17 00:00:00 2001 From: Cyrus Leung Date: Thu, 26 Jun 2025 23:18:36 +0800 Subject: [PATCH] [Doc] Auto sign-off for VSCode (#20132) Signed-off-by: DarkLight1337 --- docs/contributing/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/contributing/README.md b/docs/contributing/README.md index d472366c43b5a..83525436be139 100644 --- a/docs/contributing/README.md +++ b/docs/contributing/README.md @@ -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