Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 2 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ This file provides guidance for AI coding agents (Claude Code, Cursor, Codex, Am
- **Setup (core)**: `pnpm setup-dev` — core DBs (Doltgres, Postgres, SpiceDB), env config, migrations, admin user
- **Setup (optional services)**: `pnpm setup-dev:optional` — Nango + SigNoz + OTEL + Jaeger (run `setup-dev` first)
- **Optional services lifecycle**: `pnpm optional:stop` | `pnpm optional:status` | `pnpm optional:reset`
- **Check (full CI gate)**: `pnpm check` — runs lint + typecheck + test + format:check + env-descriptions + knip (mirrors CI exactly)
- **Lint**: `pnpm lint` (check) or `pnpm lint:fix` (auto-fix) or `pnpm check:fix` (Biome fix)
- **Format**: `pnpm format` (auto) or `pnpm format:check` (verify)
- **Typecheck**: `pnpm typecheck`
Expand Down Expand Up @@ -265,10 +266,7 @@ This product has **50+ customer-facing** and **100+ internal tooling/devops** su

2. **Run verification commands** to ensure everything passes:
```bash
pnpm test
pnpm typecheck # or pnpm tsc --noEmit
pnpm build
pnpm lint
pnpm check # runs the full CI gate: lint + typecheck + test + format:check + env-descriptions + knip
pnpm format # IMPORTANT: Always run formatter before committing
```

Expand Down
11 changes: 4 additions & 7 deletions agents-docs/content/community/contributing/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ The pre-commit hook runs `pnpm lint-staged`, which:

#### Pre-push Hook

The pre-push hook runs `pnpm check:prepush` (lint, typecheck, and tests) for all packages except docs and cookbook templates.
The pre-push hook runs `pnpm format` to auto-format code before pushing.

##### Bypassing Checks

Expand All @@ -156,8 +156,7 @@ git commit --no-verify -m "emergency: hotfix for production"

### Local checks (CI parity)

- `pnpm check` runs lint, typecheck, and tests (the same set CI runs).
- CI also runs `pnpm format:check` and `pnpm knip`.
- `pnpm check` mirrors the full CI merge gate: lint, typecheck, tests, format verification, env-description validation, and dead code detection (knip).
- For package-specific commands, see `AGENTS.md` below.

# CLI Development
Expand Down Expand Up @@ -257,12 +256,10 @@ Types:

Our CI pipeline runs on all pull requests and includes:

- `pnpm check` (lint, typecheck, tests)
- `pnpm format:check`
- `pnpm knip`
- `pnpm check` (lint, typecheck, tests, format verification, env-description validation, knip)
- Create Agents E2E tests (separate job)

These checks must pass before a PR can be merged. Pre-commit uses lint-staged, pre-push runs `pnpm check:prepush`, and CI is the source of truth.
These checks must pass before a PR can be merged. Pre-commit uses lint-staged, pre-push runs `pnpm format`, and CI is the source of truth.

# AI coding assistants and coding practices

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"typecheck": "turbo typecheck --filter='!agents-cookbook-templates'",
"typecheck:watch": "turbo typecheck:watch",
"precheck": "pnpm install --frozen-lockfile",
"check": "turbo check --filter='!agents-cookbook-templates'",
"check": "turbo check --filter='!agents-cookbook-templates' && pnpm format:check && pnpm check:env-descriptions && pnpm knip",
"check:husky": "turbo check:husky --filter='!agents-cookbook-templates' --filter='!@inkeep/agents-docs'",
"check:prepush": "turbo check:prepush --filter='!agents-cookbook-templates' --filter='!@inkeep/agents-docs'",
"check:fix": "biome check --write",
Expand Down
Loading