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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

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

wants to merge 1 commit into from

Conversation

edlerd
Copy link

@edlerd edlerd commented Nov 11, 2024 •
edited
Loading

Describe your change:

  • Documentation change

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

Done

  • Updated contributing guidelines with a hint for Windows users to execute the pre commit hooks.

Fixes #12352

@algorithms-keeper algorithms-keeper bot added documentation This PR modified documentation files awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass labels Nov 11, 2024
@edlerd edlerd force-pushed the update-contributions branch 2 times, most recently from e59f206 to 21aedc9 Compare November 11, 2024 11:53
@edlerd
Copy link
Author

edlerd commented Nov 11, 2024

The failing ruff test seems unrelated.

I tried removing the noqa: ... comment as ruff suggests, but then pre commit step of CI fails.

cclauss
cclauss reviewed Nov 11, 2024
View reviewed changes
CONTRIBUTING.md
<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

@cclauss
Copy link
Member

cclauss commented Nov 11, 2024

Ruff was fixed in #12370 if you rebase.

Which pre-commit hook fails on Windows?

@edlerd
Copy link
Author

edlerd commented Nov 11, 2024

Ruff was fixed in #12370 if you rebase.

thx, will rebase this tomorrow morning.

Which pre-commit hook fails on Windows?

I came here because of this issue: #12352 It details on what exactly the problem is and is pointing to the solution I added to the docs with this change.

@edlerd
Copy link
Author

edlerd commented Nov 12, 2024 •
edited
Loading

Closing this, because #12371 fixes it in a better way.

@edlerd edlerd closed this Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss left review comments

Assignees
No one assigned
Labels
awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files tests are failing Do not merge until tests pass
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update CONTRIBUTING.md Regarding Validate filenames Fail
2 participants
@edlerd @cclauss