Contributing docs: local test runs silently skip SpatiaLite and ext.c tests, and the setup steps assume SSH and uv

Abierto Apto para principiantes
  • ¿Algo no está bien?
#928 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
84/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python, sqlite
Área
documentation, testing

Línea de trabajo

Lee docs/contributing.rst junto con .github/workflows/test.yml para adaptar la configuración para colaboradores al entorno de CI. Actualiza las instrucciones de clonación para clonar forks mediante HTTPS, enlaza las instrucciones de instalación de uv y documenta la configuración local de las pruebas de SpatiaLite y ext.c con los comandos del issue. El trabajo estará terminado cuando la página explique estos requisitos previos y los colaboradores puedan identificar por qué esas pruebas podrían omitirse localmente de otro modo.

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

Descripción

Following docs/contributing.rst on a fresh macOS machine, I hit three gaps:

  1. The clone command uses SSH (git clone [email protected]:simonw/sqlite-utils). It worked for me because I already have an SSH key on GitHub, but it fails with Permission denied (publickey) for anyone without one, and contributors usually need to clone their fork rather than the main repository.

  2. Every command uses uv run, but the page does not say uv must be installed or link to its install instructions.

  3. uv run pytest passes locally while skipping tests that CI runs. On my machine: 1,494 passed, 19 skipped. pytest -rs shows 12 skips in tests/test_gis.py ("Could not find SpatiaLite extension") and 3 in tests/test_cli.py ("Requires compiled ext.c"). CI installs libsqlite3-mod-spatialite and compiles ext.c in .github/workflows/test.yml, but the contributing page mentions neither, so a contributor changing GIS code can get a green local run and a red CI run.

Environment: macOS 26.2, Python 3.11.5, uv 0.13.7, sqlite-utils main at 9c66baf.

Proposed fix, in docs/contributing.rst: clone your fork over HTTPS, link https://docs.astral.sh/uv/getting-started/installation/, and add a "Tests that skip locally" section with brew install spatialite-tools (macOS) or apt-get install libsqlite3-mod-spatialite (Ubuntu) and cd tests && gcc ext.c -fPIC -shared -o ext.so.

Related: #900 (docs build command) and #872 (CI legs that never run a pandas test). Happy to open a PR for this.

Lenguaje dominante
Python
Estrellas
2.2k
Forks
215
Sin PR fusionados en 30 d

Preparar el entorno

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 simonw/sqlite-utils

Todos los issues de simonw/sqlite-utils

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.