Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (44 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 1.56 KB
Raw

Contributing Guide

Setup

Install pnpm

# Enable pnpm with corepack, only available on Node.js >= `v14.19.0`
corepack enable

Install Dependencies

pnpm install

Development

Run build:dev command to generate the binary dynamic link library compiled from the Rust code into the current directory for debugging purposes.

pnpm build:dev

The index.js will is will try to load the corresponding binary from the current directory in this case, see NAPI - Getting started.

Testing

# Run Rust test cases
cargo test

# Run Node.js test cases
pnpm run vitest

Submitting Changes

Add a Changeset

This repo is using Changesets to manage the versioning and changelogs.

If you've changed some packages, you need add a new changeset for the changes. Please run change command to select the changed packages and add the changeset info.

pnpm run changeset

Format of PR titles

The format of PR titles follow Conventional Commits.

An example:

feat(plugin-swc): Add `xxx` config
^    ^    ^
|    |    |__ Subject
|    |_______ Scope
|____________ Type

Publishing

  1. Run Release Pull Request action to create a release pull request.
  2. Run Release action the release the packages and crates.