VFM Contribution Guide

Prerequisites

This project uses mise to manage the Node.js and pnpm versions declared in mise.toml. See the mise installation guide and Activate mise for setup.

Development Guide

git clone https://github.com/vivliostyle/vfm.git && cd vfm

# Install the Node.js and pnpm versions defined in mise.toml
mise install

# Install dependencies for all workspace packages
pnpm install

# Build every package in the workspace
pnpm build

# Expose the CLI on your PATH for local testing
cd packages/vfm
pnpm link --global
DEBUG=vfm vfm

To watch sources during development:

pnpm --filter @vivliostyle/vfm dev

To run the test suite across the workspace:

pnpm test

Commit Guide

Comment

Please refer to Semantic Commit Messages for the commit comment.

Changeset

For each user-facing change, add a changeset: run pnpm changeset and commit the generated .changeset/*.md.

Release Guide (Maintainers only)

Releases are automated with Changesets and published to npm through OIDC trusted publishing.

Pending changesets on main drive a "Version Packages" pull request. Merging it makes the workflow publish the changed packages to npm and create the matching git tags and GitHub Releases.