MetaMask / MetaMask/contributor-docs

Create React Best Practices Documentation

Aperta
#1 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

category-documentation github-migration-triaged team-wallet-framework wf-documentation
Lingua principale
JavaScript
Stelle
86
Fork
42
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando i pattern esistenti per componenti, context e hook React nelle codebase di extension e mobile, annotando gli approcci deprecati e quelli attualmente promossi. Prepara una bozza indipendente dal prodotto per raccogliere input da @MetaMask/extension-devs e @MetaMask/mobile-devs, quindi conferma che le pratiche condivise siano approvate e ratificate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
react
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Tranquilla
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.