Create Redux Best Practices + design goals Document
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- redux
- Domain
- documentation
Research direction
Start with the Redux style guide at https://redux.js.org/style-guide/style-guide and review the contributor-docs repository structure to locate the best place for the document. Gather examples from the extension and mobile products, then outline guidance for new and existing stores, long-term Redux design goals, and relationships with MetaMask Core and the controllers repo. Done means the document is ready for ratification by both engineering groups.
Written by the indexing model from the issue text.
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.
- 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
-
bug confirmed issue
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
open-webui/open-webui#30750 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Mend: dependency security vulnerability untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 70/100