Create React Best Practices Documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- react
- Domain
- documentation
Research direction
Start by reviewing the existing React component, context, and hook patterns in the extension and mobile codebases, noting deprecated and currently promoted approaches. Prepare a product-agnostic draft for input from both @MetaMask/extension-devs and @MetaMask/mobile-devs, then confirm that the shared practices are approved and ratified.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- JavaScript
- Stars
- 86
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from MetaMask/contributor-docs
-
Difficulty 1/5 Under an hour Newbie friendliness 62/100
MetaMask/contributor-docs#164 ·
-
category-documentation github-migration-triaged team-wallet-framework wf-documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MetaMask/contributor-docs#115 · 1 comment ·
-
issueOpen
Difficulty 5/5 Over a week Newbie friendliness 10/100
MetaMask/contributor-docs#169 ·
-
team-core-platform
Difficulty 4/5 3-5 days Newbie friendliness 45/100
MetaMask/contributor-docs#157 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
MetaMask/contributor-docs#142 ·
All issues in MetaMask/contributor-docs
Similar issues
-
factory-active factory-automatic harness/codex task-bug-reproduction-success task-identify-harness-labels-done task-identify-issue-type-done
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
vercel/ai#21582 · 3 comments ·
Maintainers usually reply within 1 day
-
ux
Difficulty 1/5 Under an hour Newbie friendliness 90/100
rr-djk/rr-djuikoo.com#53 ·
Maintainers usually reply within 1 day
-
new spec review
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
w3c/browser-specs#2666 · 1 comment ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
thim81/openapi-format#238 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
decentespresso/dye2#13 ·