mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-22 09:57:02 +01:00
1fd3dc9ecf
As a solution to the constant lockfile churn issues we've had with `npm`, the project now uses `yarn` to manage dependencies. The `package-lock.json` file has been replaced with `yarn.lock`, which was created using `yarn import`. It should approximate the contents of `package-lock.json` fairly well, though there may be some changes due to deduplication. The codeowners file has been updated to reference this new lockfile. All documentation and npm scripts have been updated to reference `yarn` rather than `npm`. Note that running scripts using `npm run` still works fine, but it seemed better to switch those to `yarn` as well to avoid confusion. The `npm-audit` Bash script has been replaced with `yarn-audit`. The output of `yarn audit` is a bit different than `npm audit` in that it returns a bitmask to describe which severity issues were found. This made it simpler to check the results directly from the Bash script, so the associated `npm-audit-check.js` script was no longer required. The output should be exactly the same, and the information is still sourced from the same place (the npm registry). The new `yarn-audit` script does have an external dependency: `jq`. However, `jq` is already assumed to be present by another CI script, and is present on all CI images we use. `jq` was not added to `package.json` as a dependency because there is no official package on the npm registry, just wrapper scripts. We don't need it anywhere exept on CI anyway. The section in `CONTRIBUTING` about how to develop inside the `node_modules` folder was removed, as the advice was a bit dated, and wasn't specific to this project anyway. |
||
|---|---|---|
| .. | ||
| components | ||
| extension_description | ||
| add-to-chrome.md | ||
| add-to-firefox.md | ||
| adding-new-networks.md | ||
| architecture.png | ||
| bumping_version.md | ||
| creating-metrics-events.md | ||
| design-system.md | ||
| developing-on-deps.md | ||
| development-visualization.md | ||
| form_persisting_architecture.md | ||
| limited_site_access.md | ||
| multi_vault_planning.md | ||
| porting_to_new_environment.md | ||
| publishing.md | ||
| QA_Guide.md | ||
| README.md | ||
| secret-preferences.md | ||
| send-screen-QA-checklist.md | ||
| sensitive-release.md | ||
| state_dump.md | ||
| team.md | ||
| transaction-flow.png | ||
| translating-guide.md | ||
| trezor-emulator.md | ||
| video_script.txt | ||
Documentation
These docs relate to how to contribute to the MetaMask project itself.
You can find the latest version of MetaMask on our official website.
For help using MetaMask, visit our User Support Site.
For up to the minute news, follow our Twitter or Medium pages.
To learn how to develop MetaMask-compatible applications, visit our Developer Docs.
- How to add custom build to Chrome
- How to add custom build to Firefox
- Publishing Guide
- How to live reload on local dependency changes
- How to add new networks to the Provider Menu
- How to port MetaMask to a new platform
- How to generate a visualization of this repository's development
- How to add a feature behind a secret feature flag