Contributing to dotUI

Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Your contributions to this project are not just welcome, but deeply valued. We sincerely appreciate every effort you make to improve and enhance dotUI.

Please take a moment to review this document before starting your contribution.

How to contribute

Prerequisites

In order to not waste your time implementing a change that has already been declined, or is generally not needed, start by opening an issue describing the problem you would like to solve.

This project requires:

• Node.js v24 (v24.11.1 or higher)
• pnpm v11.5.3 or higher

npm install -g pnpm@latest

Setup your environment locally

1. Fork the repository by clicking the fork button in the top right corner of this page.

2. Clone the repository on your local machine

git clone https://github.com/your-username/dotui.git

3. Create a new branch

git checkout -b my-new-branch

4. Install the dependencies

pnpm install

5. Build the component registry (required once before the dev server works)

pnpm build:registry

Project structure

This project is a Turborepo monorepo:

• www/ - Documentation website
• packages/ - Shared packages
  • colors - Color utilities
  • types - Shared TypeScript types
• config/ - Shared configuration (TypeScript configs)

Useful scripts

Command	Description
pnpm dev	Starts all packages in development mode
pnpm dev:www	Starts the documentation website
pnpm build	Builds all packages
pnpm build:www	Builds the documentation website
pnpm build:registry	Builds the component registry
pnpm lint:check	Runs Oxlint
pnpm lint:fix	Fixes Oxlint issues
pnpm format:check	Checks Oxfmt formatting
pnpm format:fix	Formats files with Oxfmt
pnpm check	Runs lint and format checks
pnpm check:fix	Fixes lint and format issues
pnpm typecheck	Runs TypeScript type checking
pnpm test	Runs tests

Before submitting

Check that your code passes all checks:

pnpm check
pnpm typecheck
pnpm test

Credits

This document was inspired by the contributing guidelines for t3-oss/create-t3-app.