Contributing

Using corepack is suggested to manage your pnpm version. Otherwise make sure that you are using the node and pnpm versions listed under the engines key in the root package.json file ("node": "18.17.0" and "pnpm": "8.10.2" at the time of writing).

pnpm install

pnpm build

pnpm run

Package publishing has been configured using Changesets. Please review their documentation to familiarize yourself with the workflow.

This repository comes with automated npm releases setup in a GitHub Action. To get this working, you will need to create an NPM_TOKEN and GITHUB_TOKEN in your repository settings. You should also install the Changesets bot on your GitHub repository as well.

For more information about this automation, refer to the official changesets documentation

To publish a new package to a private npm organisation scope, make sure the name uses the @adaptavant scope and ensure the package.json contains the following.

"publishConfig": {
  "registry": "https://npm.pkg.github.com"
}

See Working with the npm registry