From 6375e30aed2be03031e2b47ba7098d7f18cd8f46 Mon Sep 17 00:00:00 2001 From: Bao Date: Mon, 29 Jun 2026 05:31:49 +0700 Subject: [PATCH] docs: clarify local check vs CI steps --- CHANGELOG.md | 2 +- CONTRIBUTING.md | 4 ++-- README.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a7583b9..658ac56 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -81,7 +81,7 @@ Registered at user scope by `agentctx init`; runs as `agentctx mcp`. - Node 20/22/24 support matrix enforced at `init` (OQ-1 resolved); ABI-mismatch and missing-prebuild failures on unsupported Node versions are translated into actionable support-matrix guidance (`cli/node-support.ts`) instead of a stack trace; native code is never compiled on the install path - End-to-end test (`test/e2e.test.ts`): init → hook invocations with fixture payloads → mocked Anthropic API extraction → consolidation → SessionStart digest correctness; both injection budgets asserted (≤1,500 / ≤2,000 tokens); session dedup verified; extraction cost lands on the session row - Invariant audit: superseded records do not surface in any default path (hooks, MCP, CLI search/export/status); concurrent WAL writes verified safe; hooks exit 0 against missing and corrupt stores -- 287 tests across unit, integration, and end-to-end suites; `npm run check` (lint + typecheck + test) is the CI gate +- 287 tests across unit, integration, and end-to-end suites; CI runs lint plus the build/test matrix, while `npm run check` is the full local gate (lint + typecheck + build + test) --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d01efb..d7040e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,7 +27,7 @@ npm ci # install (Node ≥ 20, see .nvmrc) npm run build # compile TypeScript npm run test # vitest npm run lint # biome (lint + format) -npm run check # everything CI runs +npm run check # local full gate: lint + typecheck + build + test ``` ## Contribution Standards @@ -67,4 +67,4 @@ signature is required. Opening a PR constitutes agreement. ## Questions Open a [GitHub Discussion](https://github.com/agentctxhq/agentctx/discussions) -for anything that is not a bug or feature request. \ No newline at end of file +for anything that is not a bug or feature request. diff --git a/README.md b/README.md index a187de4..f16aa88 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ npm ci # install workspace dependencies npm run build # compile TypeScript (all packages) npm run test # run tests (vitest) npm run lint # lint + format check (biome) -npm run check # lint + typecheck + test, what CI runs +npm run check # local full gate: lint + typecheck + build + test ``` Requires Node ≥ 20 (see `.nvmrc`).