Skip to content

Fix CONTRIBUTING.md monorepo references #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HabibiCodeCH merged 1 commit into from
Jul 21, 2026
Merged

Fix CONTRIBUTING.md monorepo references #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)

Expand Down
Loading