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

chore: Add instructions regarding tool versions and env variables in Readme #8788

Merged
merged 5 commits into from
Mar 5, 2024

Conversation

kylanhurt
Copy link
Contributor

@kylanhurt kylanhurt commented Feb 29, 2024

Description

The MetaMask Mobile Platform team has identified improvements to the read me as a way improving the developer experience and onboarding.

Related issues

Fixes: #8622 improves the effectiveness of the read me.

Manual testing steps

  1. Read the repository Readme.md file

Screenshots/Recordings

Before:

8622-before.mov

After:

8622-after.mov

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

github-actions bot commented Feb 29, 2024

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.

NicolasMassart
NicolasMassart previously approved these changes Mar 1, 2024
Copy link
Contributor

@NicolasMassart NicolasMassart left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Set defaults for .js.env.example (will get copied over to .js.env and remove unneeded instructions
@kylanhurt kylanhurt added needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) team-mobile-platform labels Mar 1, 2024
@codecov-commenter
Copy link

codecov-commenter commented Mar 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.61%. Comparing base (6fe35ba) to head (ab2f122).

❗ Current head ab2f122 differs from pull request most recent head 80a3e6f. Consider uploading reports for the commit 80a3e6f to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8788   +/-   ##
=======================================
  Coverage   41.60%   41.61%           
=======================================
  Files        1269     1269           
  Lines       30859    30859           
  Branches     3082     3082           
=======================================
+ Hits        12840    12842    +2     
+ Misses      17243    17242    -1     
+ Partials      776      775    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kylanhurt kylanhurt added the Spot Check on the Release Build If a ticket doesn't require feature QA, but does require some form of manual spot checking label Mar 1, 2024
@kylanhurt
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@kylanhurt kylanhurt marked this pull request as ready for review March 1, 2024 17:18
@kylanhurt kylanhurt requested a review from a team as a code owner March 1, 2024 17:18
@github-actions github-actions bot added the Run Smoke E2E Triggers smoke e2e on Bitrise label Mar 1, 2024
Copy link
Contributor

github-actions bot commented Mar 1, 2024

https://bitrise.io/ Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: ef51376
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/8a1286ca-0381-47d5-9daf-46e549258b76

Note

  • You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

@kylanhurt kylanhurt self-assigned this Mar 1, 2024
@kylanhurt kylanhurt changed the title Add instructions regarding tool versions and env variables in Readme Chore: Add instructions regarding tool versions and env variables in Readme Mar 1, 2024
@kylanhurt kylanhurt changed the title Chore: Add instructions regarding tool versions and env variables in Readme chore: Add instructions regarding tool versions and env variables in Readme Mar 1, 2024
Cal-L
Cal-L previously approved these changes Mar 1, 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.

LGTM

@Cal-L Cal-L dismissed their stale review March 1, 2024 19:27

Leaving another comment

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 comment

README.md Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Mar 1, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

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.

LGTM

@kylanhurt kylanhurt added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Mar 4, 2024
Copy link
Contributor

github-actions bot commented Mar 4, 2024

https://bitrise.io/ Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 348639c
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/74d509db-1334-4159-a9b0-5bed06832f08

Note

  • You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

@NicolasMassart NicolasMassart added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Mar 5, 2024
@kylanhurt kylanhurt merged commit e9f3351 into main Mar 5, 2024
34 of 39 checks passed
@kylanhurt kylanhurt deleted the kylan/readme branch March 5, 2024 15:14
@github-actions github-actions bot locked and limited conversation to collaborators Mar 5, 2024
@github-actions github-actions bot removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Mar 5, 2024
@metamaskbot metamaskbot added the release-7.19.0 Issue or pull request that will be included in release 7.19.0 label Mar 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
release-7.19.0 Issue or pull request that will be included in release 7.19.0 Run Smoke E2E Triggers smoke e2e on Bitrise Spot Check on the Release Build If a ticket doesn't require feature QA, but does require some form of manual spot checking team-mobile-platform
Projects
Archived in project
5 participants