← 输入框|github.com|刷新
Skip to content

docs: say Python 3.11+ now that 3.10 is dropped - #665

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-yhcml9
Nov 8, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-yhcml9

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 8, 2026 •

Copy link
Copy Markdown
Member

What

#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.

@shenxianpeng
shenxianpeng requested a review from a team as a code owner November 8, 2026 14:13
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 8, 2026
@shenxianpeng shenxianpeng self-assigned this Nov 8, 2026
@coderabbitai

coderabbitai Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The README quick-start command and the contribution guide now document Python 3.11 as the minimum version.

Changes: Python version documentation

Layer / File(s) Summary
Update documented minimum version
README.md, CONTRIBUTING.md
The quick-start command and development prerequisites now specify Python 3.11 instead of Python 3.10.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Possibly related issues

  • 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

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: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed 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 Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed 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.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • 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.

@sonarqubecloud

sonarqubecloud Bot commented Nov 8, 2026

Copy link
Copy Markdown

@shenxianpeng
shenxianpeng merged commit 933a27f into main Nov 8, 2026
12 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-yhcml9 branch November 8, 2026 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant