docs: document the contributor testing workflow
Los mantenedores suelen responder en 2 días
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 78/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comienza localizando la documentación para contribuidores y las pruebas pytest existentes para humanize.clamp(), usando el issue #429 como referencia de ejemplo. Añade una sección breve que cubra el descubrimiento de pruebas, las convenciones del repositorio, los casos parametrizados, los comandos para ejecutar pruebas específicas y la suite completa, y la verificación de regresiones; se considera terminado cuando el flujo de trabajo sea claro para quienes contribuyen por primera vez.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Problem
As a first-time contributor, I found it difficult to determine the
expected workflow for adding and verifying tests.
While working on #429, I had to figure out:
- how to find the appropriate test file
- how to follow the repository's existing pytest conventions
- how to run focused tests
- how to run the full test suite
- how to verify that a regression test actually fails when the
protected behavior is broken
The current contributor documentation does not explain this workflow
for someone making their first test contribution.
Proposed change
Add a short contributor-testing section explaining how to:
- Find the relevant existing test file.
- Follow the repository's existing test patterns.
- Add parameterized test cases where appropriate.
- Run the relevant tests locally.
- Intentionally verify that the test catches a regression.
- Run the full test suite before opening a PR.
The section would use a small example based on the existing test suite.
Motivation
I encountered this while working on #429, where I added parameterized
tests for two-sided humanize.clamp() boundary behavior.
I also intentionally introduced a regression to verify that the new
test failed, then restored the implementation and ran the full suite.
Related PR: #429
- Lenguaje dominante
- Python
- Estrellas
- 760
- Forks
- 166
- Merge medio
- 4 d 3 h
- PR fusionados (30 d)
- 7
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de python-humanize/humanize
-
intcomma returns scientific notation for large floatsPosiblemente ocupada @TheNetherWatcher la tomó hace 4 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
python-humanize/humanize#431 ·
Los mantenedores suelen responder en 2 días
-
docs: document how to run the test suite locallyPosiblemente ocupada @yuefdev la tomó hace 4 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
python-humanize/humanize#430 ·
Los mantenedores suelen responder en 2 días
-
metric() adds a digit when a value rounds into quettaPosiblemente ocupada @SashaMIT la tomó hace 6 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
python-humanize/humanize#423 ·
Los mantenedores suelen responder en 2 días
-
precisedelta() silently drops the sign of negative timedeltasPosiblemente ocupada @Mukller la tomó hace 43 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
python-humanize/humanize#379 ·
Los mantenedores suelen responder en 2 días
-
`naturalsize()` raises `ValueError` for custom format strings with textPosiblemente ocupada @Sanjays2402 la tomó hace 67 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
python-humanize/humanize#366 ·
Los mantenedores suelen responder en 2 días
Todos los issues de python-humanize/humanize
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
-
Harmony OPeNDAP SubSetter (HOSS) Geographic LARC_CLOUD PREFIRE_SAT2_AUX-SAT R01 production
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
nasa/harmony-autotester#245 ·
-
[FEATURE] - Add UTVD supportAbiertoenhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Deltares/imod-python#1928 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100