Skip to content

Latest commit

 

History

History
82 lines (46 loc) · 3.49 KB

README.md

File metadata and controls

82 lines (46 loc) · 3.49 KB
Raw

home.metamask.io

Contributing

Managing featured dapps

You need to submit a pull request to this repo with your changes to the file: https://github.com/MetaMask/dapps/blob/master/src/data/featured-dapps.js

Managing dapps inside categories

You need to submit a pull request to this repo with your changes to the file: https://github.com/MetaMask/dapps/blob/master/src/data/all-dapps.js

Dapp icons

If you're adding a new dapp to the list, make sure you add its icon under ./public/images/dapps/

If you're deleting a dapp from the list, make sure that you're deleting its icon (but check it's not in use in another category!)

Development

Available commands:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Release

The project follows the same release process as the other projects in the MetaMask organization.

  1. Choose a release version.

    • The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See the SemVer specification for more information.

  2. If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. 1.x for a v1 backport release).

    • The major version branch should be set to the most recent release with that major version. For example, when backporting a v1.0.2 release, you'd want to ensure there was a 1.x branch that was set to the v1.0.1 tag.

  3. Create a release PR branch using the following syntax release/x.x.x.

  4. Run yarn auto-changelog on the release branch and check that the changelog is correctly formatted.

    • Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).
    • Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
    • Consolidate related changes into one change entry if it makes it easier to explain.

  5. Dev review and QA the release.

    • If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.

Deployments

  • Make sure you have the netlify client configured with your credentials and you have access to the project.

Staging

  • npm run deploy

Production

  • npm run deploy:prod