Contributing
Thank you for your interest in contributing to RAG Chat!
Quick Links
Development Setup
bash
# Clone your fork
git clone https://github.com/YOUR_USERNAME/rag.git
cd rag
# Install dependencies
npm install
# Start development servers
npx convex dev # Terminal 1
npm run dev # Terminal 2Available Scripts
| Command | Description |
|---|---|
npm run dev | Start Vite dev server |
npx convex dev | Start Convex dev server |
npm run build | Build for production |
npm run typecheck | Run TypeScript checks |
npm run lint | Run ESLint |
npm run format | Check Prettier formatting |
npm run check | Run all checks |
npm run fix | Auto-fix lint/format issues |
Pull Request Process
- Create a feature branch from
main - Make your changes
- Run
npm run checkto verify everything passes - Push and open a Pull Request
- Fill out the PR template
- Wait for review
Code Style
- TypeScript for type safety
- ESLint for linting
- Prettier for formatting
Run npm run fix to auto-fix most issues.
