-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Improve README.md #8492
docs: Improve README.md #8492
Conversation
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8492 +/- ##
=======================================
Coverage 41.05% 41.05%
=======================================
Files 1247 1247
Lines 30371 30371
Branches 2965 2965
=======================================
Hits 12468 12468
Misses 17158 17158
Partials 745 745 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left a question
2f7f001
to
de68b2c
Compare
Quality Gate passedIssues Measures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
Reduce README.md content to focus on building and running the app.
Documentation files linked on Table of Contents.
First iteration just focus on iOS platform.
Related issues
Fixes: https://github.com/MetaMask/mobile-planning/issues/1533
Manual testing steps
Comparisson
main: https://github.com/MetaMask/metamask-mobile/tree/main#readme
improved readme: https://github.com/MetaMask/metamask-mobile/tree/chore/tldr-readme#readme
Screenshots/Recordings
Before
After
Pre-merge author checklist
Pre-merge reviewer checklist