CONTRIBUTING.md

Contributing Guide

Thanks for that you are interested in contributing to Farrow.

Developing

To develop locally:

1. Fork this repository to your own GitHub account and then clone it to your local.

2. Create a new branch:

   git checkout -b MY_BRANCH_NAME

3. Install pnpm:

   npm install -g pnpm

4. Install the dependencies with:

   pnpm install

5. Go into package which you want to contribute.

   cd ./packages/*

6. Start developing.

Building

You can build single package, with:

cd ./packages/*
pnpm run build

build all packages, with:

pnpm run build

If you need to clean all node_modules/* the project for any reason, with

pnpm run clean:deps

Clean build outputs with

pnpm run clean:build

Clean all of them

pnpm run clean

Testing

You need write th new tests for new feature or modify exist tests for changes.

We wish you write unit tests at PACKAGE_DIR/__tests__.

Run Testing

pnpm run test

Linting

To check the formatting of your code:

pnpm run lint

Formatting

To format your code:

pnpm run format

Publishing

We use pnpm and changeset to manage version and changelog.

Repository maintainers can publish a new version of all packages to npm.

1. Fetch newest code at branch main.

2. Install

   pnpm install

3. Build

   pnpm run build

4. Add changeset

   pnpm run change

5. Release

   pnpm run release

6. Push commit and tag

   git push
   git push --tag