Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (36 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1.67 KB

Contributing to the Project

Thank you for considering contributing to our project! Here are some guidelines to help you get started.

Prerequisites

Before you begin your dev work, ensure you have met the following requirements:

  • Node.js 22.13.0 or higher is installed on your machine
  • Yarn 4.0.0 or higher is installed on your machine

Recommended: Install Node.js and Yarn via Volta

The recommended way to manage Node.js and Yarn versions is to use Volta. Volta is a tool that allows you to define and install Node.js and Yarn versions on a per-project basis. Volta will pick the correct versions for package managers and node version.

This ensures that the correct versions are used when working on a project based on the package.json.

Alternative: Use Corepack

Corepack is a tool that manages package managers like Yarn and PNPM as if they were Node.js modules. This allows you to install Yarn as based on the package.json packageManager field.
It's been included in Node.js since 16.

  1. Ensure that Node.js 22 is installed on your machine.
  2. Enable Corepack: 
    corepack enable
  3. Check that yarn v4 is installed: 
    yarn --version

Validating Changes

Before submitting a pull request, ensure that your changes pass the following checks:

  • The code is formatted using Prettier
  • The code passes the ESLint checks
  • The code passes the Jest tests
  • The code passes the TypeScript checks

To run these checks, use the following commands:

yarn check

To fix automatically fixable issues, use the following command:

yarn fix