contributing.md

Contributing to r18gs

Contribute

Once you have cloned the repo. cd to the repo directory and use following commands.

Build

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

pnpm build

Develop

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

pnpm dev

Run unit tests

To run unit tests, run the following command:

pnpm test

Linting and formating

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

pnpm lint

and

pnpm format

You can also contribute by

1. Sponsoring
2. Check out discussion for providing any feedback or sugestions.
3. Report any issues or feature requests in issues tab

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

Library, Examples and Packages

This Turborepo includes the following packages/examples:

React18 Global Store library

You will find the core library code inside lib/r18gs

Examples (/examples)

• nextjs: a Next.js app
• vite: a Vite.js app
• remix: a Remix app

Packages (/packages)

• eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• tsconfig: tsconfig.jsons used throughout the monorepo
• shared-ui: An internal UI package for shared UI code

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

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

---

🤩 Don't forger to star this repo!

with 💖 by Mayank Kumar Chaudhari