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

Abierto
  • ¿Algo no está bien?
#189 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
54/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
docker, github-actions, python
Área
ci-cd, devops

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Python
Estrellas
1.9k
Forks
313
Merge medio
1 d 7 h
PR fusionados (30 d)
21

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ShisatoYano/AutonomousVehicleControlBeginnersGuide

Todos los issues de ShisatoYano/AutonomousVehicleControlBeginnersGuide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.