Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (27 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 1.36 KB
Raw

Contributing

Thanks for your interest in openforge. The repo is small (~800 lines) on purpose. PRs that grow the surface area need to justify the addition.

Setup

git clone https://github.com/krish9219/openforge
cd openforge
cp .env.example .env       # set OPENAI_API_KEY
npm install
npm test                    # tests run without an API key
npm run dev                 # http://localhost:3000

High-value contributions

  • lib/workspace.ts is the security boundary. Any change here needs a test that proves a path-traversal attempt is rejected.
  • New provider in lib/llm.ts (Anthropic is a clean ~30-line add).
  • Tests for the file API (/api/files).
  • UX improvements to the chat / file tree / editor that don't grow the file count by more than ~50 lines.
  • CI improvements.

Unlikely to be accepted

  • Inline ghost-text completion. Requires deep IDE-grade behavior; out of scope for the simple browser editor.
  • Codebase embeddings / RAG. The "model sees what it reads" guarantee is intentional.
  • Multi-user / auth in the core. Run behind a reverse proxy with basic auth.
  • Cursor / VS Code-style command palette with hundreds of commands.

PR checklist

  • npm test passes.
  • npm run build produces no type errors.
  • If you touched lib/workspace.ts, you added or updated a sandbox test.
  • README is updated if behavior changed.