Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (37 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

62 lines (37 loc) · 2.75 KB
Raw

Contributing to Aptos Wallet Adapter

Understand the Repo

Aptos Wallet Adapter is a monorepo built with turbo and follows its file structure convention. The repo has 2 workspaces apps and packages

Apps Workspace

The App workspace hold different web apps such as the adapter demo app (a nextjs app). You are welcome to add different apps (react/vue/etc) in this workspace (make sure you are following turbo best practices on how to do it)

Packages Workspace

The packages workspace holds 2 main packages

  1. wallet-adapter-core - the core adapter logic that responsible on the adapter functionality, state and the interaction between the dapp and wallet.
  2. wallet-adapter-react - a light react provider that dapps can import and use the adapter.

You are welcome to add packages (vue-provider/UI frameworks/etc) in this workspace (make sure you are following turbo best practices on how to do it)

Develop Locally

You would need pnpm@7.14.2 in order to bootstrap and test a local copy of this repo.

  1. Clone the repo with git clone https://github.com/aptos-labs/aptos-wallet-adapter.git
  2. On the root folder, run pnpm install and pnpm turbo run build
  3. On the root folder, run pnpm turbo run dev - that would spin up a local server (localhost:3000) with the nextjs demoapp

Creating a pull request

You are welcome to create a pull request against the main branch.

Before creating a PR

  1. Make sure your branch is up to date with the main branch
  2. Make sure nothing breaks in the nextjs demo app
  3. On the root folder, run pnpm install
  4. On the root folder, run pnpm turbo run build

If everything passes, you should be able to create a PR.

Changesets

We use changesets to handle any changes in the changelog. If a pull request created needs to bump a package version, please follow those steps to create a changelog

  1. On the root folder, run pnpm run changeset and follow the prompt instructions (we follow SemVer)
  2. Under .changeset/ you will notice a new markdown file (its name is randomly generated), with the change-type and summary.
  3. Push the file along with the rest of the changes

Once your PR will be merged, our Github action will create a new PR with that generated changelog for us to merge, once the generated PR is merged a new version will be published to npm.

Deploy

If you made some changes to the nextjs demo app, you would want to deploy those changes once they are merged.

To do that

  1. On the root folder in the main branch, run git pull to make sure you have the latest main
  2. On the root folder, run deploy:example - that would handle the nextjs app deployment.