You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: say Python 3.11+ now that 3.10 is dropped - #665
#662 raised requires-python to >=3.11, but two lines still say 3.10. README.md is also the PyPI project description, so v2.20.0 would go out telling people "Python 3.10+" while pip refuses to install it there.
Before / after
File
Before
After
README.md, Quick start
pip install commit-check # Python 3.10+
# Python 3.11+
CONTRIBUTING.md, Prerequisites
Python 3.10 or newer
Python 3.11 or newer
On Python 3.10, pip install of the main-branch wheel stops with Package 'commit-check' requires a different Python: 3.10.20 not in '>=3.11'.
No other 3.10 or tomli mention is left outside uv.lock and the tests.
Summary by CodeRabbit
Documentation
Updated the documented minimum Python version to 3.11 in the development prerequisites and quick-start instructions.
commit-check/commit-check#658 — This PR documents the Python 3.11 minimum, but does not change the runtime configuration or imports covered by the issue.
Possibly related PRs
commit-check/commit-check#662 — That PR sets Python 3.11 as the minimum in pyproject.toml; this PR documents the same minimum.
Suggested reviewers:invictustitan2
Merge Risk: Minimal · up to bdc70
The documentation now matches the repository’s Python 3.11 minimum. No merge-blocking risk is identified.
Pre-merge checks: 4
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title "docs: say Python 3.11+ now that 3.10 is dropped" matches the changeset. The PR changes the Python prerequisite from 3.10+ to 3.11+ in CONTRIBUTING.md and the README quick-start install comm…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title "docs: say Python 3.11+ now that 3.10 is dropped" matches the changeset. The PR changes the Python prerequisite from 3.10+ to 3.11+ in CONTRIBUTING.md and the README quick-start install command, so the title names the main change. The title uses a conventional commit prefix and is short, specific, and readable. It is a single sentence under 50 characters.
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
File: No configuration file from this repository applied
Commit: Unavailable
Layers: defaults
Review profile: CHILL
Plan: Advanced
Run ID: 809c0326-f813-4cc1-965f-e23535daa1f7
Commits
Reviewing files that changed from the base of the PR and between bd2ed6e and bdc7092.
Files selected for processing: 2
CONTRIBUTING.md
README.md
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
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
documentationImprovements or additions to documentation
1 participant
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.
What
#662 raised
requires-pythonto>=3.11, but two lines still say 3.10. README.md is also the PyPI project description, so v2.20.0 would go out telling people "Python 3.10+" while pip refuses to install it there.Before / after
pip install commit-check # Python 3.10+# Python 3.11+Python 3.10 or newerPython 3.11 or newerOn Python 3.10,
pip installof the main-branch wheel stops withPackage 'commit-check' requires a different Python: 3.10.20 not in '>=3.11'.No other
3.10ortomlimention is left outsideuv.lockand the tests.Summary by CodeRabbit