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

オープン
#189 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
54/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
docker, github-actions, python
領域
ci-cd, devops

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Python
スター
1.9k
フォーク
313
平均マージ
1日 7時間
マージ済み PR(30日)
21

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ShisatoYano/AutonomousVehicleControlBeginnersGuide のほかの issue

ShisatoYano/AutonomousVehicleControlBeginnersGuide の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。