CONTRIBUTING.md

Setting up the environment

This repository uses pnpm.

To set up the repository, run:

pnpm install
pnpm build

This will install all the required dependencies and build output files to the root directory.

Using the repository from source

You can link a local copy of the repo:

# Clone
git clone https://www.github.com/langtail/langtail-node
cd langtail-node

# With pnpm
pnpm link
cd ../my-package
pnpm link langtail

# With pnpm
pnpm link --global
cd ../my-package
pnpm link -—global langtail

Running tests

pnpm run test

Linting and formatting

This repository uses prettier and eslint to format the code in the repository.

To check types run:

pnpm ts

To format all the code run:

pnpm format

Publishing and releases

When you push a new tag (vX.Y.Z), Github Action will automatically publish this version.

Also create a release from the tag in Github so the Changes are easily visible in https://github.com/langtail/langtail-node/releases