Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.08 KB

DEVELOPMENT.md

File metadata and controls

31 lines (21 loc) · 1.08 KB

Weaverse SDKs Development

These instructions are for internal Weaverse development. If you're looking to contribute to the Weaverse SDKs, please refer to the Contribution Guidelines.

Workflow

We currently use pnpm to develop our SDKs.

  1. Fork & Clone: Fork this repository and clone it to your local machine.

  2. Install Dependencies: Navigate to the desired package or sample project and install dependencies:

    pnpm install
  3. Run Development Server: Start the development server:

    pnpm run dev

Releases

We're using Changesets to manage our releases. When you're ready to begin the release process, follow these steps:

  1. Run pnpm changeset to create a new changeset.
  2. Run pnpm changeset version to bump the version of the packages that need to be upgraded.
  3. Run pnpm changeset publish to publish the new version of the packages to npm.
  4. Commit and push the changes to the main branch.
  5. Release the new version of the packages on GitHub.