darkwing / metamask-module-template

A simple template repository for starting new modules in the latest MetaMask fashion.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MetaMask Module Template

This TypeScript module is maintained in the style of the MetaMask team.

Installation

yarn add @metamask/this-module

or

npm install @metamask/this-module

Usage

Add examples here

API

Add examples here

Testing

Run yarn test to run the tests once.

To run tests on file changes, run yarn test:watch.

Release & Publishing

The project follows the same release process as the other libraries in the MetaMask organization:

  1. Create a release branch
  • For a typical release, this would be based on main
  • To update an older maintained major version, base the release branch on the major version branch (e.g. 1.x)
  1. Update the changelog
  2. Update version in package.json file (e.g. yarn version --minor --no-git-tag-version)
  3. Create a pull request targeting the base branch (e.g. master or 1.x)
  4. Code review and QA
  5. Once approved, the PR is squashed & merged
  6. The commit on the base branch is tagged
  7. The tag can be published as needed

About

A simple template repository for starting new modules in the latest MetaMask fashion.


Languages

Language:JavaScript 77.2%Language:TypeScript 22.8%