From 21aedc9df9f68d45a89348c711a21a858262cea7 Mon Sep 17 00:00:00 2001 From: David Edler Date: Mon, 11 Nov 2024 12:42:42 +0100 Subject: [PATCH] Update contribution guidelines, add note for windows users #12352 Signed-off-by: David Edler --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3df39f95b784..9b17b9694e3e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,6 +73,23 @@ That's it! The plugin will run every time you commit any changes. If there are a pre-commit run --all-files --show-diff-on-failure ``` + +
+ Hint for windows users +
+ On Windows, the python3 command is not recognized. This can lead to the error below. + 
running into the error `hook id: validate-filenames exit code: 9009
+ + You can create a symbolic link to the 'python.exe' file on your machine. Follow these steps: + + 1. Open the command prompt as admin (cmd). + 2. Navigate to your Python directory. + 3. Create a symbolic link using the following command: + + 
mklink python3.exe python.exe
+ +
+ #### Coding Style We want your work to be readable by others; therefore, we encourage you to note the following: