Skip to content

Comments

Add CONTRIBUTING.md with macOS local development setup guide#472

Open
jeanduplessis wants to merge 4 commits intomainfrom
docs/contributing-guide
Open

Add CONTRIBUTING.md with macOS local development setup guide#472
jeanduplessis wants to merge 4 commits intomainfrom
docs/contributing-guide

Conversation

@jeanduplessis
Copy link
Contributor

Summary

  • Adds a comprehensive CONTRIBUTING.md for macOS local development setup
  • Covers prerequisites (Xcode CLI tools, Homebrew, Git LFS, Node 22 via nvm, pnpm, Docker, Vercel CLI, Stripe CLI)
  • Documents project setup steps: clone, install, env vars, database, migrations, dev server
  • Explains fake login and admin access conventions (@admin.example.com)
  • Documents enterprise trial management in local dev (dev org creation, require_seats bypass, admin panel)
  • Documents Cloudflare Workers and AI inference in local dev (port assignments, limitations, what works without workers)
  • Includes common troubleshooting section

Comprehensive guide covering prerequisites, project setup, fake login
and admin access, enterprise trial management, Cloudflare Workers and
AI inference in local dev, and common troubleshooting steps.
Update README.md references to point to CONTRIBUTING.md instead.
@kiloconnect
Copy link
Contributor

kiloconnect bot commented Feb 23, 2026

Code Review Summary

Status: No Issues Found | Recommendation: Merge

This PR adds a comprehensive CONTRIBUTING.md with macOS local development setup instructions, replaces the inline setup steps in README.md with a link to the new guide, and removes the old dev/macos dev-environment installation.txt.

I verified the documentation against the actual codebase:

  • ✅ Package scripts (dev, test, validate, lint, format, etc.) match their descriptions
  • ✅ Docker Compose config matches the database setup instructions
  • .nvmrc and package.json engines confirm Node 22 requirement
  • ✅ Pre-commit hook behavior matches the Git Workflow section
  • lint-staged config matches the description (Prettier + typecheck)
  • pnpm add -g vercel uses correct pnpm syntax (previously flagged, now fixed)
  • pnpm validate description accurately reflects lint:changed and format:changed (previously flagged, now fixed)
  • src/db/schema.ts path is valid
  • pnpm script:run command exists
  • api/dev/create-kilocode-org route exists
  • ✅ No HTML <img> tags (markdown-only)
Files Reviewed (3 files)
  • CONTRIBUTING.md (new) - 0 issues
  • README.md - 0 issues
  • dev/macos dev-environment installation.txt (deleted) - 0 issues

The step-by-step setup instructions are now maintained in a single
place (CONTRIBUTING.md) rather than duplicated across both files.
…ption

- Use 'pnpm add -g' instead of 'pnpm install -g' (canonical syntax)
- Clarify that 'pnpm validate' runs lint:changed and format:changed, not full lint/format
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant