Contributing guidelines

Internal packages of note

Constants used across Formsort projects.

Shared ESLint configuration for use across all projects.

Shared tsconfig for use across all projects.

First, install all the dependencies (using Volta is highly recommended):

yarn install --frozen-lockfile

This will install all the dependencies of the sub packages, and also creates symlinks between references within this repository.

Now, you can edit across packages. Commit your changes when you are happy.

Create a folder in /packages and initialize a project there (yarn init).

To allow the project to be public on npm registry, specify the following in the package.json:

"publishConfig": {
  "access": "public"
}