Document high-level MetaMask architecture (from a package/controller perspective)
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 28/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
Start by mapping the extension, mobile app, core controllers, and packages mentioned in the issue, including eth-sig-util, from the package/controller perspective. Decide how those pieces should appear in an architecture graph and companion package list. Done means a new document contains both views and gives each package a short role summary.
Written by the indexing model from the issue text.
Description
Someone new to MetaMask might look at all of the repos that we have and (after they get over their initial shock) ask, how do all of these pieces fit together?
There are a few ways we could answer that question, but to start, we could create an architecture graph that includes the extension, mobile app, and packages that are used along the way (including core controllers, but also libraries like eth-sig-util). To provide another view, we could have a list below the graph which summarizes all of the packages with a short summary of the role that they play. Then we put both of these things in a new document.
- Dominant language
- JavaScript
- Stars
- 86
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Contributor guide
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 ·
-
issue Open
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
-
curation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#186 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
clerk/javascript#9852 ·
-
bug p1 tools
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
factory-active factory-automatic task-bug-reproduction-cannot-reproduce task-identify-harness-labels-done task-identify-issue-type-done
Difficulty 2/5 1-3 hours Newbie friendliness 84/100