MetaMask / MetaMask/contributor-docs

Create Redux Best Practices + design goals Document

Ouverte
#2 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

team-wallet-framework wf-documentation
Langage dominant
JavaScript
Étoiles
86
Forks
42
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Note, https://redux.js.org/style-guide/style-guide is essentially our best practices document. However it might serve to use this document as a starting point, reference it and encapsulate some examples from either product to show what it means. This document will help to guide engineers in creating new stores in Redux, as well as in modifying exisitng ones. For the goals portion of this document we should describe what some long term goals would be for the redux store, some of the design considerations and how they will work together with things like MetaMask Core, The controllers repo, etc. This document will be ratified by members of both @MetaMask/extension-devs and @MetaMask/mobile-devs and will be continuously updated as our needs change.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par le guide de style de Redux à l’adresse https://redux.js.org/style-guide/style-guide et examinez la structure du dépôt contributor-docs afin de trouver le meilleur emplacement pour le document. Rassemblez des exemples provenant des produits extension et mobile, puis décrivez les recommandations pour les nouveaux Stores et les Stores existants, les objectifs de conception de Redux à long terme et les relations avec MetaMask Core et le dépôt controllers. Le travail sera terminé lorsque le document sera prêt à être ratifié par les deux groupes d’ingénierie.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
redux
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.