Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

docs: document the contributor testing workflow

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#438 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 2 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
78/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Beginne damit, die Dokumentation für Mitwirkende und die vorhandenen pytest-Tests für humanize.clamp() zu finden, wobei Issue #429 als Beispielreferenz dient. Füge einen kurzen Abschnitt hinzu, der das Auffinden von Tests, die Konventionen des Repositorys, parametrisierte Fälle, Befehle für fokussierte Tests und die vollständige Testsuite sowie die Überprüfung von Regressionen abdeckt; als erledigt gilt die Aufgabe, wenn der Ablauf für Mitwirkende ohne Vorerfahrung klar ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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:

  1. Find the relevant existing test file.
  2. Follow the repository's existing test patterns.
  3. Add parameterized test cases where appropriate.
  4. Run the relevant tests locally.
  5. Intentionally verify that the test catches a regression.
  6. 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

Vorherrschende Sprache
Python
Sterne
760
Forks
166
Ø Merge
4 T. 3 Std.
Gemergte PRs (30 T.)
7

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python-humanize/humanize

Alle Issues in python-humanize/humanize

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.