Add missing controller guidelines
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 67/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- typescript
- Domain
- documentation
Research direction
Find the existing controller guidelines and package guidelines in the repository; the issue does not name their files. Read the surrounding guidance, then incorporate the listed controller state, test setup, messenger mocking, and package-version notes where appropriate. Done when the relevant guidelines cover these points without duplicating or contradicting existing guidance.
Written by the indexing model from the issue text.
Description
We have some missing controller guidelines:
- State should be coherent at all times. If properties are intended to be used in conjunction with each other they should be consistent, and we should have runtime validation to ensure that this is always the case.
- Use
withControllerorsetupControllerpattern to set up controllers in tests. - Don't mock the messenger in tests.
Although the following is a package guideline, we could consider repeating it in the controller guidelines because that is probably more likely the use case:
- New controller packages should always start at 0.0.0 (otherwise they run the risk of being accidentally published).
- Dominant language
- TypeScript
- Stars
- 413
- Forks
- 308
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 253
Contributor guide
No contributing guide indexed for this repository
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/core
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug v2
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/inspector#2458 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
carbon-design-system/ibm-products#9907 ·