MetaMask / MetaMask/contributor-docs

Create React Best Practices Documentation

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

Dieses Issue hat noch niemand übernommen.

category-documentation github-migration-triaged team-wallet-framework wf-documentation
Vorherrschende Sprache
JavaScript
Sterne
86
Forks
42
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

The extension code base has several patterns of component structures in it, some of which are deprecated while others are the current promoted way of writing react components. The purpose of this document is to encapsulate all of our best practices such that a new contributor is not guessing on the appropriate way to build components (as well as how to do the other parts of React, such as contexts, hooks, etc).

This document is product *agnostic* and will need to have members of both @MetaMask/extension-devs and @MetaMask/mobile-devs weigh in on the final document to make sure that it properly reflects shared principles. The document that fulfills this ticket need not be a reflection of the current state of the products, either. If during discussion we agree upon a shared best practice across products but one product team has not yet implemented any instances of that best practice, that is fine. Documentation that is created in this repo is subject to change, approval and ratification of updates.

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 mit der Prüfung der bestehenden Muster für React-Komponenten, Context und Hooks in den Codebasen von Extension und Mobile und halte dabei veraltete sowie derzeit empfohlene Ansätze fest. Erstelle einen produktunabhängigen Entwurf zur Rückmeldung durch @MetaMask/extension-devs und @MetaMask/mobile-devs und bestätige anschließend, dass die gemeinsamen Praktiken genehmigt und ratifiziert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Ruhig
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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