Skip to content
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

Merged
merged 23 commits into from
Feb 16, 2024
Merged

docs: Improve README.md #8492

merged 23 commits into from
Feb 16, 2024

Conversation

frankvonhoven
Copy link
Contributor

@frankvonhoven frankvonhoven commented Jan 31, 2024

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

Screenshot 2024-02-14 at 16 53 02

After

Screenshot 2024-02-14 at 16 52 55

Pre-merge author checklist

  • I’ve followed MetaMask Coding Standards.
  • I've clearly explained what problem this PR is solving and how it is solved.
  • I've linked related issues
  • I've included manual testing steps
  • I've included screenshots/recordings if applicable
  • I’ve included tests if applicable
  • I’ve documented my code using JSDoc format if applicable
  • I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.
  • I’ve properly set the pull request status:
    • In case it's not yet "ready for review", I've set it to "draft".
    • In case it's "ready for review", I've changed it from "draft" to "non-draft".

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

Copy link
Contributor

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.

@jpcloureiro jpcloureiro changed the title Chore/tldr readme Improve README.md Feb 8, 2024
@jpcloureiro jpcloureiro marked this pull request as ready for review February 8, 2024 16:30
@jpcloureiro jpcloureiro requested a review from a team as a code owner February 8, 2024 16:30
@jpcloureiro jpcloureiro added the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Feb 8, 2024
@codecov-commenter
Copy link

codecov-commenter commented Feb 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (542af2c) 41.05% compared to head (de68b2c) 41.05%.

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.
📢 Have feedback on the report? Share it here.

@jpcloureiro jpcloureiro changed the title Improve README.md docs: Improve README.md Feb 14, 2024
Copy link
Contributor

@Cal-L Cal-L left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a question

scripts/build.sh Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link

sonarcloud bot commented Feb 16, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Contributor

@sethkfman sethkfman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sethkfman sethkfman merged commit c58517c into main Feb 16, 2024
26 checks passed
@sethkfman sethkfman deleted the chore/tldr-readme branch February 16, 2024 20:34
@github-actions github-actions bot locked and limited conversation to collaborators Feb 16, 2024
@github-actions github-actions bot removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Feb 16, 2024
@metamaskbot metamaskbot added the release-7.18.0 Issue or pull request that will be included in release 7.18.0 label Feb 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
release-7.18.0 Issue or pull request that will be included in release 7.18.0 team-mobile-platform
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

7 participants