Python version policy: test all supported versions and update once a year

Đang mở
  • Có gì không ổn?
#189 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
54/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
docker, github-actions, python
Lĩnh vực
ci-cd, devops

Hướng nghiên cứu

Start with HOWTOCONTRIBUTE.md and doc/ARCHITECTURE.md to define the yearly Python support policy, then inspect the CI workflow matrix and the README, Dockerfile, .devcontainer/devcontainer.json, and Update_Examples_Gallery.yml version settings. Check dependency support for Python 3.11–3.15 and document any version left out of CI. Done when the policy is documented, the recommended version is applied to the listed files, and CI passes across the supported matrix.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

announce enhancement good first issue

Part of #131.

Problem

CI tests only Python 3.13, and the README, the Dockerfile and the gallery workflow all use 3.13. There is no rule for when to move to a newer version or which versions are supported.

  • Users run different versions (for example 3.10 on Ubuntu 22.04 and 3.12 on Ubuntu 24.04), but only one is tested
  • The library release (#172) needs to declare requires-python
  • The Dockerfile is pinned to python:3.13.0, so it doesn't get the bug and security fixes of later 3.13.x releases

Expected change

  1. Write the policy in HOWTOCONTRIBUTE.md (and refer to it from doc/ARCHITECTURE.md):
    • Supported versions: every Python version that hasn't reached its end of life. CI tests all of them
    • Recommended version: the newest version minus one. The README, the Dockerfile, the devcontainer and the gallery workflow use it. The newest version is not recommended right after its release, because the dependencies (numpy, scipy, matplotlib, casadi, do-mpc) may not have wheels for it yet
    • Yearly review in December or January, after the October release of Python: add the new version to CI once the dependencies support it, move the recommended version up by one, and drop versions that reached their end of life
  2. Apply it for this year:
    • CI matrix (Linux, macOS, Windows): 3.11 to 3.15. A version that a dependency doesn't support yet stays out of the matrix, with a comment saying why
    • Recommended version: 3.14 in the README, Dockerfile (python:3.14, without a patch number), .devcontainer/devcontainer.json and Update_Examples_Gallery.yml

Done when

  • The policy is in HOWTOCONTRIBUTE.md
  • CI passes on every supported version in the matrix
  • The README, the Dockerfile, the devcontainer and the gallery workflow use the recommended version

Related: #172 (requires-python of the package), #165 (book versions follow the same yearly cycle).

Ngôn ngữ chính
Python
Star
1.9k
Fork
313
Merge trung bình
1 ngày 7 giờ
Pull request đã merge (30 ngày)
21

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ShisatoYano/AutonomousVehicleControlBeginnersGuide

Tất cả issue của ShisatoYano/AutonomousVehicleControlBeginnersGuide

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.