testcontainers / testcontainers/testcontainers-python
Docs: Improve docs with examples
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 2.3k
- Forks
- 386
- Ø Merge
- 4 Std. 40 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
What are you trying to do?
I am trying to implement testcontainer in python but struggling to understand the flow
Why should it be done this way?
- Add examples in the landing page
- Examples for each mantained module
- Examples with pytest
Extra Info
I will try to do a PR
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Landingpage und die Dokumentation jedes gepflegten Moduls zu lesen, um die aktuelle Struktur und fehlende Beispiele zu ermitteln. Füge auf der Landingpage und in den Modulen Python-Nutzungsbeispiele hinzu, einschließlich pytest-basierter Beispiele; abgeschlossen ist die Aufgabe, wenn die Beispiele die angeforderten Bereiche abdecken und für jemanden verständlich sind, der den Ablauf lernt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- docker, python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100