Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (20 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.24 KB
Raw

Root.js Contributing Guide

Repo Setup

The package manager used to install and link dependencies must be pnpm.

To get started:

  1. Run pnpm i in the main workspace folder.
  2. Run pnpm build in the main workspace folder.
  3. Run pnpm dev in any examples folder to start a dev server.
  4. If you are developing a root package, you can go into the package's folder and run pnpm dev to automatically rebuild whenever you change its code.

Pull Request Guidelines

  • PR title must follow the commit message convention.
  • Any change that should have a changelog entry should have a changeset (see "Creating a Changeset" section)

Creating a Changeset

  1. Run pnpm changeset
  2. Select the package(s) that should include a short message explaining your change using spacebar
  3. Select whether the version bump should be Major (breaking changes), Minor (new feature), or Patch (bug fixes)
  4. Add the newly created changeset file along with your commit

Releases and Branching

See RELEASING.md for the branching strategy used across major versions, including how patch releases are maintained on prior majors and how pre-releases of the next major are published under npm dist-tags.