Thanks for that you are interested in contributing to Farrow.
To develop locally:
-
Fork this repository to your own GitHub account and then clone it to your local.
-
Create a new branch:
git checkout -b MY_BRANCH_NAME
-
Install pnpm:
npm install -g pnpm
-
Install the dependencies with:
pnpm install
-
Go into package which you want to contribute.
cd ./packages/*
-
Start developing.
You can build single package, with:
cd ./packages/*
pnpm run buildbuild all packages (incremental, faster for local dev), with:
pnpm run buildrun a full clean build (recommended for release verification), with:
pnpm run build:fullIf you need to clean all node_modules/* the project for any reason, with
pnpm run clean:depsClean build outputs with
pnpm run clean:buildClean all of them
pnpm run cleanYou need write th new tests for new feature or modify exist tests for changes.
We wish you write unit tests at PACKAGE_DIR/__tests__.
pnpm run testTo check the formatting of your code:
pnpm run lintTo format your code:
pnpm run formatWe use pnpm and changeset to manage version and changelog.
Repository maintainers can publish a new version of all packages to npm.
-
Fetch newest code at branch
main. -
Install
pnpm install
-
Build (clean build for release safety)
pnpm run build:full
-
Add changeset
pnpm run change
-
Release
pnpm run release
-
Push commit and tag
git push git push --tag