Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 801 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 801 Bytes

Contribution Guidelines

If you read this, first of all, thank you! It means a lot.

Issues

A minimal reproduction of the issue is very recommended for us to fix your bug as soon as possible.

Getting started

  1. Fork and clone the repository
  2. Install dependencies with pnpm install
  3. Start the development environment with pnpm dev

Proposing changes

  1. Do your changes. Please add tests if possible.
  2. Commit.
  3. Run pnpm changeset to create a changeset.
  4. Submit the PR.

Testing

To run the test suite, you can run pnpm test from the root of the repository.

If you propose changes, we highly recommend you to add some tests that covers your changes or feature.

Publishing

💡 This is mostly for maintainers

Run pnpm publish-packages to publish the package.