docs: add note on Python version for pre-commit #9028
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TomeHirata
reviewed
Nov 10, 2025
|
|
||
| Python 3.10 or later is required. | ||
|
|
||
| > **Note on Python Versions:** While the setup instructions below recommend Python 3.11 for development, our `pre-commit` hooks (in `.pre-commit-config.yaml`) are configured to use **Python 3.10**. |
Collaborator
There was a problem hiding this comment.
Can we change the instruction below to 3.10 instead? We should make sure our package works with the oldest supported version.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a warning note to the
CONTRIBUTING.mdfile.The Problem:
The "Environment Setup" guide recommends using
Python 3.11, but the.pre-commit-config.yamlfile requiresPython 3.10. This causespre-commit installto fail for new contributors who follow the instructions and only havePython 3.11.The Fix:
This note clarifies the discrepancy before the setup instructions. It advises contributors to either ensure
python3.10is also available on their PATH or simply usepython=3.10for their virtual environment to satisfy both requirements.Hi @TomeHirata , I've pushed the requested changes. Thanks!