Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (51 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

71 lines (51 loc) · 2.43 KB
Raw

Contributing to devcoach

Quick start

git clone https://github.com/UltimaPhoenix/dev-coach && cd dev-coach
npm install
npm run dev -- mcp   # run the MCP server from source (tsx)
npm run dev -- ui    # run the web dashboard from source

Before every commit

npm run lint         # Biome check (auto-fix: npm run format)
npm run typecheck    # TypeScript
npm run test:cov     # Vitest — coverage must stay ≥ 80% lines

All three must pass before opening a PR.

Architecture rules

See CLAUDE.md for the full project structure, stack, and conventions. The critical ones:

  • core/ must never import from mcp/, cli/, or web/
  • Every DB access must be wrapped in try/catch — never crash the MCP server
  • Paths always derived from os.homedir()/.devcoach, never hardcoded
  • assets/ is the tracked source of truth (SKILL.md + web static) — edit there, not in dist/

Submitting a PR

  1. Fork the repo and create a branch from main
  2. Make your changes and confirm all checks pass
  3. Open a PR against main with a clear description of what and why — and state any change you made to existing behaviour
  4. Sign the Contributor License Agreement — the CLA Assistant bot comments on your PR with a one-line phrase to post; signing is required before merge

Keep PRs focused. A change that fixes a bug and adds a feature should be two PRs.

Licensing & the CLA

devcoach is licensed under AGPL-3.0 and is also offered under a separate commercial license. So that contributions can ship under both, every contributor signs a lightweight Contributor License Agreement: you confirm you have the right to contribute and you grant the maintainer the right to license your contribution under both AGPL and commercial terms. The CLA Assistant bot handles this automatically on your first PR.

See also: Code of Conduct · Security policy · License.

Testing with the MCP inspector

npm run build
npx @modelcontextprotocol/inspector node dist/bin.js mcp

Sandbox mode (keeps your real ~/.devcoach safe)

HOME=$(mktemp -d) node dist/bin.js stats
HOME=$(mktemp -d) npm run dev -- mcp

Building the Claude Desktop extension

npm run mcpb          # → dist-mcpb/devcoach-<version>.mcpb
npm run mcpb:sign     # self-sign (shows as unverified publisher)