Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (31 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

39 lines (31 loc) · 1.02 KB

Contributing to CodeLens

Local Development

Prerequisites

  • Node.js 22+, npm 11+
  • Python 3.12+
  • Git

Setup

git clone https://github.com/ritunjaym/codelens
cd codelens
cp .env.example .env
npm install
pip install fastapi uvicorn python-dotenv pydantic pydantic-settings httpx pytest pytest-asyncio httpx

Running Tests

# Python tests
pytest /Users/ritunjay/Desktop/codelens/ml/ /Users/ritunjay/Desktop/codelens/apps/api/tests/ -v

# Frontend unit tests  
cd apps/web && npm run test

# E2E tests (requires running server)
cd apps/web && npm run test:e2e

Coding Standards

  • Python: ruff check . --fix + mypy apps/api/
  • TypeScript: eslint apps/web/ + TypeScript strict mode
  • Commits: Conventional Commits (feat, fix, test, docs, chore, perf)
  • Scopes: ml, api, web, partykit, infra, docs, tests, ci

No Secrets Policy

Never commit credentials. All secrets via .env (gitignored). Pre-check: grep -r "ghp_\|sk-\|AKIA" --include="*.py" --include="*.ts" .