Contributing to Open-Prism
January 28, 2026 ยท View on GitHub
Development Environment
Requirements
- Node.js 20+
- pnpm 10+
- TeX Live (for local latex-api development)
Setup
# Clone the repository
git clone https://github.com/assistant-ui/open-prism.git
cd open-prism
# Install dependencies
pnpm install
# Copy environment variables
cp apps/web/.env.example apps/web/.env.local
# Edit apps/web/.env.local with your configuration
# Start development
pnpm dev:web
Running LaTeX API locally
# Requires TeX Live installed
cd apps/latex-api
pnpm dev
Code Style
This project uses Biome for linting and formatting.
# Check code
pnpm lint
# Auto-fix issues
pnpm lint:fix
Pull Request Process
- Fork the repository
- Create a feature branch (
git checkout -b feat/my-feature) - Make your changes
- Run
pnpm lintto ensure code quality - Commit with a descriptive message
- Push to your fork and open a PR
Commit Convention
Use conventional commits:
feat:new featurefix:bug fixdocs:documentationrefactor:code refactoringchore:maintenance tasks