CONTRIBUTING.md

Contributing Guidelines

Getting Started

Pre-requisites

• Git installed
• Node.js installed
• pnpm package manager installed

Fork the repository

Fork the repository by clicking on the fork button on the top of the page. This will create a copy of this repository in your account.

Clone your fork

Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

Change directory to the folder you just cloned to.

cd "folder name"

Install dependencies

pnpm install

Build the motion package

Building the motion package is necessary to compile the latest code changes and ensure that the package functions correctly within the project. This step generates the necessary build artifacts, allowing you to develop, test, and verify your modifications effectively

cd packages/motion

pnpm build

Start the development server

go to root again

cd ../..

go to playground/nuxt where you can test the motion package.

cd playground/nuxt

install dependencies

pnpm install

start the development server

pnpm run dev

This will start the development server and open the browser with the playground.