docs: document the contributor testing workflow
Les mainteneurs répondent en général sous 2 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 78/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par localiser la documentation destinée aux contributeurs et les tests pytest existants pour humanize.clamp(), en utilisant l’issue #429 comme référence d’exemple. Ajoutez une courte section couvrant la découverte des tests, les conventions du dépôt, les cas paramétrés, les commandes pour les tests ciblés et la suite complète, ainsi que la vérification des régressions ; le travail est terminé lorsque le processus est clair pour les contributeurs débutants.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- Python
- Étoiles
- 760
- Forks
- 166
- Merge moyen
- 4 j 3 h
- PR mergées (30 j)
- 7
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de python-humanize/humanize
-
intcomma returns scientific notation for large floatsPeut-être pris @TheNetherWatcher l’a pris il y a 4 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
python-humanize/humanize#431 ·
Les mainteneurs répondent en général sous 2 jours
-
docs: document how to run the test suite locallyPeut-être pris @yuefdev l’a pris il y a 4 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
python-humanize/humanize#430 ·
Les mainteneurs répondent en général sous 2 jours
-
metric() adds a digit when a value rounds into quettaPeut-être pris @SashaMIT l’a pris il y a 5 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
python-humanize/humanize#423 ·
Les mainteneurs répondent en général sous 2 jours
-
precisedelta() silently drops the sign of negative timedeltasPeut-être pris @Mukller l’a pris il y a 43 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
python-humanize/humanize#379 ·
Les mainteneurs répondent en général sous 2 jours
-
`naturalsize()` raises `ValueError` for custom format strings with textPeut-être pris @Sanjays2402 l’a pris il y a 67 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
python-humanize/humanize#366 ·
Les mainteneurs répondent en général sous 2 jours
Toutes les issues de python-humanize/humanize
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 83/100
Les mainteneurs répondent en général sous 1 jour
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
fabriziosalmi/certmate#1207 ·
Les mainteneurs répondent en général sous 1 jour
-
[work-item] adam-adae-onset-emergence: document the minute-precision datetime coercion (ASTTMF not derivable)Peut-être pris @muse-yamaa-bot l’a pris aujourd’hui. Ouvertework-item
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
CommunityToolkit/Aspire#2231 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
volcengine/OpenViking#5711 ·
Les mainteneurs répondent en général sous 1 jour