reactjs / reactjs/react.dev

TestRenderer and ShallowRenderer docs are extremely limited.

Offen
#1,572 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
11.8k
Forks
7.9k
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
11

Beschreibung

None of the api methods are thoroughly documented.
None of the api methods have example code provided.
None of the api methods have typing information for arguments and/or return values.

In order to use either of these libraries you have to do a ton of examining debugger results, digging through source code, and/or digging through Stackoverlow.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Dokumentation zu TestRenderer und ShallowRenderer sowie deren öffentliche API-Einstiegspunkte zu finden. Überprüfe jede API-Methode, um fehlende Beschreibungen, Beispiele sowie Informationen zur Typisierung von Argumenten oder Rückgabewerten zu identifizieren. Als abgeschlossen gilt die Aufgabe, wenn beide Bibliotheken eine umfassende Methodendokumentation mit Beispielen und Typisierungsdetails haben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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