contributing.md

Contributing to fork-me

What's inside?

Utilities

This Turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Apps and Packages

This Turborepo includes the following packages/examples:

• nextjs: a Next.js app
• vite: a Vite.js app
• eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• tsconfig: tsconfig.jsons used throughout the monorepo

To increase the visibility we have moved core library to lib

• fork-me: a React component library shared by both nextjs and vite examples lives in ./lib/fork-me

Each package/example is 100% TypeScript.

Automatic file generation

• just run yarn turbo gen and follow the propts to auto generate your new component with test file and dependency linking
• follow best practices automatically

Build

To build all apps and packages, run the following command:

cd fork-me
pnpm build

Develop

To develop all apps and packages, run the following command:

cd fork-me
pnpm dev

Run unit tests

To run unit tests, run the following command:

cd fork-me
pnpm test

Linting and formating

Before creating PR make sure lint is passing and also run formatter to properly format the code.

cd fork-me
pnpm lint

and

pnpm format

Useful Links

Learn more about Turborepo and Next.js:

• React and Next.js with TypeScript - an interactive Next.js course.
• The Game of Chess with Next.js, React and TypeScrypt
• Tasks
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage

A quick tip: Delete all stale branches git branch --merged main | grep -v '^[ *]*main$' | xargs git branch -d

---

with 💖 by Mayank Kumar Chaudhari