Contributing

First, fork and clone the repository:

git clone https://github.com/yourusername/aviris.git

Install dependencies and build the project:

pnpm install
pnpm build

The project is organized as a monorepo with the following structure:

aviris/
├── apps/
│   ├── docs/     # Documentation site
│   └── www/      # Marketing site
├── packages/
│   └── ui/       # Core UI components
└── examples/     # Example applications

1. Create a new branch for your feature or fix:

git checkout -b feat/new-component

2. Start the development server:

pnpm dev

3. Make your changes and test them thoroughly

4. Commit your changes following conventional commits:

# Examples:
git commit -m "feat: add new button variant"
git commit -m "fix: resolve button focus state"
git commit -m "docs: update component usage examples"

When creating or modifying components:

• Follow the existing component structure
• Include proper TypeScript types
• Add comprehensive tests
• Update documentation
• Ensure accessibility standards are met

Example component structure:

import * as React from "react"
import { cn } from "@aviris/ui/lib/utils"

interface ComponentProps {
  // Props interface
}

export function Component({ className, ...props }: ComponentProps) {
  // Component implementation
}

When you're ready to submit your changes:

1. Push your changes to your fork
2. Create a pull request
3. Fill out the pull request template
4. Wait for review and address any feedback