Skip to content

Update contribution guidelines, add note for windows users #12352 #12369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update contribution guidelines, add note for windows users #12352 #12369

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```


<details>
<summary>Hint for windows users</summary>
<br/>
On Windows, the python3 command is not recognized. This can lead to the error below.
Copy link
Member

@cclauss cclauss Nov 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Windows users should use py

Or in a venv, everyone should use python

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but we cannot make such assumptions for pre commit hooks, they rely on the python3 command.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#12371

<pre>running into the error `hook id: validate-filenames exit code: 9009</pre>

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:

<pre>mklink python3.exe python.exe</pre>

</details>

#### Coding Style

We want your work to be readable by others; therefore, we encourage you to note the following:
Expand Down
Loading