reactjs / reactjs/react.dev

Improve contextType docs

Offen
#1,842 1 Kommentar 1 Reaktion 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

See confusion in https://github.com/facebook/react/issues/13969.
Specific action items:

  • Clarify .contextType is available only since 16.6 (and corresponding RN/Expo release)
  • Clarify you may not be seeing it due to circular deps, and best practice is to declare it in a separate file
  • People sometimes get confused thinking that createContext value is the one you need to "update", we need to explain it's driven by state
  • Need more coherent doc structure

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 vorhandene Dokumentation zu contextType und die in Issue 13969 beschriebene Verwirrung zu lesen. Kläre die Verfügbarkeit von React 16.6, die Hinweise zu zirkulären Abhängigkeiten und die zustandsbasierte Verwendung von createContext; ordne das Material anschließend in eine kohärentere Struktur. Die Dokumentation sollte auf jede aufgeführte Unklarheit eingehen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 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.