CONTRIBUTING.md

Contributing

Repository URL: https://github.com/m10rten/suite

Technologies

• Node.js
• pnpm
• TypeScript
• React
• Next.js
• Tailwind CSS
• Jest
• ESLint
• Prettier
• Husky
• Turbo
• Zod
• Docker

Getting Started

To get started with this repository, follow the steps below.

Prerequisites

• Node.js (v18 or higher)
• pnpm (v8 or higher)

Installation

pnpm install

Running the tests

pnpm test

Running the linter

pnpm lint

Running the formatter

pnpm format

Running the type checker

pnpm typecheck

Running the build

pnpm build

Running the Dev Server(s)

pnpm dev

Running the Production Server(s)

pnpm start

Creating a new package

pnpm packages:create <package-name> <internal: true|false: default=false>

Cleaning your workspace

pnpm clean

Remaking the workspace

pnpm remake

Running reset

# this wil run `clean` and `remake`
pnpm reset

Database(s)

Databases on localhost are managed with Docker.

Starting the database(s)

pnpm db:up

Stopping the database(s)

pnpm db:down

Making Changes

1. Fork the repository on GitHub (see Fork A Repo)
2. Clone the forked repository to your local machine (see Cloning A Repository)
3. Install the dependencies (see Installation)
4. Make your changes and commit them (Wait for husky to run the formatter)
5. Push your changes to your forked repository on GitHub
6. Open a pull request on GitHub and describe your changes in detail (Wait for GitHub Actions to run the necessary checks)
7. Wait for the pull request to be reviewed and merged by a maintainer

Cloning

To clone, first fork the repository on GitHub, then clone your forked repository to your local machine.

git clone <your-forked-repository-url>

Opening a Pull Request

You can then open a pull request on GitHub to merge your changes into the main repository.

Please note that any PR's with changes on .changeset files will be rejected.

License

This project is licensed under the MIT License.