Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (40 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 1.82 KB
Raw

Contributing to GhostCode

Thanks for checking out GhostCode. This project is a small, forkable harness template—contributions that keep it understandable are especially welcome.

Good first issues

Look for issues labeled good first issue (create the label on GitHub if the filter is empty):

Starter tasks if none exist yet:

  • Add a local tool (with schema in @ghostcode/shared + executor in local-tools.ts)
  • Add or tweak a theme in packages/cli/src/theme.ts
  • Improve docs in docs/BUILD-YOUR-OWN-HARNESS.md
  • Fix install / Bun / Windows path issues

Development setup

bun install
export ANTHROPIC_API_KEY=...   # and/or OPENAI_API_KEY
bun run dev:cli

Link globally:

bun run link:cli
ghostcode

Project layout

Path Purpose
packages/shared/ Tool schemas, modes, system prompt, models
packages/cli/ TUI, transport, local tools, sessions
docs/ Deep-dive docs for forkers

See docs/BUILD-YOUR-OWN-HARNESS.md before large refactors.

Pull requests

  • Keep PRs focused—one tool or one doc section per PR when possible
  • Match existing style (TypeScript, minimal comments)
  • Test manually: bun run dev:cli, run PLAN and BUILD turns in a real repo

Forks

You do not need permission to fork and rename GhostCode (MIT). If you publish a derivative, keep the license file and consider linking back to this repo.

Feedback we care about

When opening issues, include:

  • OS, Bun version (bun --version)
  • Install path (npm -g vs clone vs bun link)
  • What you expected vs what happened

Feature requests for MCP, sub-agents, or workflow gates are fine—label them enhancement so we can prioritize from real demand.