diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 537e2a9..ddf4826 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,15 +5,15 @@ Thanks for considering a contribution. ## Before you start - For anything beyond a small fix, open an issue first to discuss the approach — it saves everyone time if the direction needs to change. -- This is a monorepo: `cli/` (the published npm package), `shared/` (types shared with `cli/`), and `web/` (the marketing/docs site at codekeel.ai). Most contributions will be to `cli/`. +- This repo has two workspaces: the root (the published npm package's source) and `shared/` (types shared with it). Most contributions will be to the root `src/`. ## Development ```bash npm install -npm run cli:dev # run the CLI against your own local logs -npm test -w cli # cli unit tests -npm run typecheck -w cli +npm run dev # run the CLI against your own local logs +npm test # unit tests +npm run typecheck ``` The CLI's Anthropic-backed features (live semantic verification, admissibility/contradiction checks, conversation mining, FEATURES.md derivation) only activate when `ANTHROPIC_API_KEY` is set in your environment — everything else works without it. @@ -22,7 +22,7 @@ The CLI's Anthropic-backed features (live semantic verification, admissibility/c - Keep PRs focused — one change, one PR. - Add or update tests alongside any behavioral change. -- Run `npm run typecheck -w cli` and `npm test -w cli` before opening the PR. +- Run `npm run typecheck` and `npm test` before opening the PR. ## Contributor License Agreement (CLA)