Skip to content

Contributing

Thank you for your interest in contributing to RAG Chat!

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 2

Available Scripts

CommandDescription
npm run devStart Vite dev server
npx convex devStart Convex dev server
npm run buildBuild for production
npm run typecheckRun TypeScript checks
npm run lintRun ESLint
npm run formatCheck Prettier formatting
npm run checkRun all checks
npm run fixAuto-fix lint/format issues

Pull Request Process

  1. Create a feature branch from main
  2. Make your changes
  3. Run npm run check to verify everything passes
  4. Push and open a Pull Request
  5. Fill out the PR template
  6. Wait for review

Code Style

  • TypeScript for type safety
  • ESLint for linting
  • Prettier for formatting

Run npm run fix to auto-fix most issues.

Released under the MIT License.