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.

Sign up for GitHub

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

Jump to bottom

Update readme local build instructions #20997

Merged
merged 7 commits into from
Sep 25, 2023
Merged

Update readme local build instructions #20997

merged 7 commits into from
Sep 25, 2023

Conversation

MajorLift
Copy link
Contributor

@MajorLift MajorLift commented Sep 21, 2023 •
edited
Loading

Description

Improvements

  • Added step for installing deps before running yarn dist.
    • Instructions should be as clear as possible with no implicit steps.
  • Added final step of running the local build in the browser.
    • Useful as additional check to confirm that build runs without issues.
    • Provides rewarding visual feedback for first-time contributors.
  • Added instructions for resolving Husky issue when making commits in VS Code.

Fixes

  • Infura no longer uses a project ID, but an API key.
  • Fixed typo in .metamaskrc.dist.

Notes

  • Renaming the INFURA_PROJECT_ID environment variable to INFURA_API_KEY might be helpful for reducing confusion down the line.
  • Issues with Redux devtools set-up instructions:
    • Obsolete use of yarn global command needs to be updated.
    • It's also unclear if remotedev-server is still needed as redux devtools seems to be functional without running yarn devtools:redux build script.
    • Will ask around and open separate issue if necessary.

Pre-merge author checklist

  • I’ve followed MetaMask Coding Standards.
  • I've clearly explained:
    • What problem this PR is solving.
    • How this problem was solved.
    • How reviewers can test my changes.
  • I’ve indicated what issue this PR is linked to: Fixes #???
  • I’ve included tests if applicable.
  • I’ve documented any added code.
  • I’ve applied the right labels on the PR (see labeling guidelines).
  • 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.

@MajorLift
fix: typo in .metamaskrc.dist file
d1abd97
@MajorLift
Update build set-up instructions in readme
0013c04 
- Infura no longer uses a project ID, but an API key.
  - Renaming the `INFURA_PROJECT_ID` env var to `INFURA_API_KEY` might be helpful for reducing confusion down the line.
- Added step for installing deps before running `yarn dist`. Wanted to keep the instructions as explicit as possible for external devs.
- Moved instructions for loading custom builds in the browser to be the last step of dev environment set-up. Useful as final check that build runs properly, and provides rewarding visual feedback for first-time contributors.
@MajorLift MajorLift added area-documentation Issues relating to documentation, in the codebase and off. team-wallet-framework labels Sep 21, 2023
@MajorLift MajorLift requested a review from a team as a code owner September 21, 2023 22:33
@MajorLift MajorLift self-assigned this Sep 21, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 21, 2023 •
edited
Loading

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.

@MajorLift
Copy link
Contributor Author

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

@MajorLift MajorLift changed the title Update readme Update readme local build instructions Sep 21, 2023
MajorLift
MajorLift commented Sep 21, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@MajorLift MajorLift marked this pull request as draft September 21, 2023 23:04
MajorLift
MajorLift commented Sep 22, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
MajorLift
MajorLift commented Sep 22, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@metamaskbot
Copy link
Collaborator

Builds ready [2aebfdf]
Page Load Metrics (1807 ± 77 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint1282381683014
domContentLoaded15122187180516077
load15122187180716177
domInteractive15122187180516077
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

@codecov
Copy link

codecov bot commented Sep 22, 2023 •
edited
Loading

Codecov Report

Patch and project coverage have no change.

Comparison is base (f690d9a) 68.35% compared to head (e789f94) 68.35%.

Additional details and impacted files 
@@             Coverage Diff             @@
##           develop   #20997      +/-   ##
===========================================
- Coverage    68.35%   68.35%   -0.00%     
===========================================
  Files         1007     1007              
  Lines        40261    40261              
  Branches     10766    10766              
===========================================
- Hits         27519    27518       -1     
- Misses       12742    12743       +1

see 1 file with indirect coverage changes

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

@MajorLift MajorLift marked this pull request as ready for review September 22, 2023 17:22
@metamaskbot
Copy link
Collaborator

Builds ready [e789f94]
Page Load Metrics (1734 ± 67 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint86154115178
domContentLoaded691521102110
load15702062173413967
domInteractive691521102110
Bundle size diffs
  • background: 0 Bytes (0.00%)
  • ui: 0 Bytes (0.00%)
  • common: 0 Bytes (0.00%)

mikesposito
mikesposito approved these changes Sep 25, 2023
View reviewed changes
Copy link
Member

@mikesposito mikesposito left a comment

Choose a reason for hiding this comment

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

LGTM!

Gudahtt
Gudahtt approved these changes Sep 25, 2023
View reviewed changes
Copy link
Member

@Gudahtt Gudahtt left a comment

Choose a reason for hiding this comment

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

LGTM!

@MajorLift MajorLift merged commit 8ac620f into develop Sep 25, 2023
9 checks passed
@MajorLift MajorLift deleted the 230920-update-readme-dev-build branch September 25, 2023 15:49
@github-actions github-actions bot locked and limited conversation to collaborators Sep 25, 2023
@metamaskbot metamaskbot added the release-11.3.0 Issue or pull request that will be included in release 11.3.0 label Sep 25, 2023
@MajorLift MajorLift linked an issue Oct 4, 2023 that may be closed by this pull request
Update README.md local build instructions #21198
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mikesposito mikesposito mikesposito approved these changes

@Gudahtt Gudahtt Gudahtt approved these changes

Assignees

@MajorLift MajorLift

Labels
area-documentation Issues relating to documentation, in the codebase and off. release-11.3.0 Issue or pull request that will be included in release 11.3.0 team-wallet-framework
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update README.md local build instructions
4 participants
@MajorLift @metamaskbot @Gudahtt @mikesposito