Contributing

Thank you for your interest in contributing to Chat UI!

Development Setup

1. Clone the repository
2. Install dependencies: npm install
3. Start development: npm run dev

Project Structure

chat-ui/
├── src/
│   ├── components/     # React components
│   ├── hooks/          # React hooks
│   ├── api/            # API client
│   ├── providers/      # Context providers
│   ├── styles/         # CSS styles
│   ├── utils/          # Utilities
│   ├── types.ts        # TypeScript types
│   └── index.ts        # Public exports
├── docs/               # VitePress documentation
└── examples/           # Example implementations

Scripts

• npm run dev - Development mode
• npm run build - Build library
• npm run lint - Run linter
• npm run docs:dev - Documentation development
• npm run docs:build - Build documentation

Pull Request Process

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Write tests if applicable
5. Update documentation
6. Submit a pull request

Code Style

• Use TypeScript
• Follow existing patterns
• Use meaningful variable names
• Add JSDoc comments for public APIs

Reporting Issues

When reporting issues, please include:

• Description of the problem
• Steps to reproduce
• Expected behavior
• Actual behavior
• Version information
• Environment details

License

By contributing, you agree that your contributions will be licensed under the MIT License.