From 1f4f6d2ea5be4d0bf1abd8c046805ca86706ae97 Mon Sep 17 00:00:00 2001 From: Nathaniel Tucker Date: Sun, 8 Mar 2026 14:13:15 -0400 Subject: [PATCH] internal: Improve AGENTS.md with CI, changesets, and targeted test info Add non-obvious context that agents need: CI pipeline summary (CircleCI for PR validation, GitHub Actions for release/auxiliary), changeset requirements with version-linking note, targeted test syntax with Jest project names, and pre-push verification command. Condense documentation updates section (details already in packages-documentation skill) and packages/AGENTS.md (details already in changeset skill). Made-with: Cursor --- AGENTS.md | 24 ++++++++++++------------ packages/AGENTS.md | 12 +----------- 2 files changed, 13 insertions(+), 23 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 4f89c0554f37..582d29d4eee9 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -20,6 +20,17 @@ Monorepo for `@data-client` npm packages. **Test naming**: `*.node.test.ts[x]` (Node), `*.native.test.ts[x]` (RN), `*.test.ts[x]` (regular) +**Targeted tests**: `yarn test --selectProjects ReactDOM --testPathPatterns packages/react` (project names: `ReactDOM`, `Node`, `ReactNative`) + +## CI + +- **CircleCI** (`.circleci/config.yml`) — PR validation: lint, typecheck, unit tests (React 17/18/native/latest), Node matrix, ESM type checks (TS 4.0–5.3+), browser build. +- **GitHub Actions** (`.github/workflows/`) — release (`changesets`), bundle size PR comments, benchmark regression detection. + +## Changesets + +Any user-facing change in `packages/*` requires a changeset. Core packages are version-linked (bumping one bumps all). See skill "changeset" for full workflow. + ## File Organization - **API definitions**: `src/resources/` within examples/apps @@ -34,18 +45,7 @@ Monorepo for `@data-client` npm packages. ## Documentation Updates -**Update docs when changing public APIs** (anything exported from package entry points like `index.ts`). - -**Always update docs for:** -- Breaking changes (removing/changing signatures, properties, or behavior; deprecations) -- New public APIs (classes, functions, methods, hooks, composables) -- New options/parameters on existing APIs - -**No docs needed for:** -- Internal/private APIs (prefixed with `_`, not exported, or marked `@internal`) -- Implementation-only changes - -Update docs **in the same commit/PR** as code changes. For writing guidelines, see skill "packages-documentation" +Update docs **in the same commit/PR** when changing public APIs (anything exported from package entry points). No docs needed for internal/private APIs. See skill "packages-documentation" for guidelines. ## Integration Details diff --git a/packages/AGENTS.md b/packages/AGENTS.md index de5cce0ec64b..d5dbb800c9ee 100644 --- a/packages/AGENTS.md +++ b/packages/AGENTS.md @@ -1,13 +1,3 @@ ## Changesets (release notes) -- **When to add**: Any user-facing change in a published package (`packages/*`) should include a changeset. -- **Command**: Run `yarn changeset` from repo root (run it once per distinct change). -- **Terse changelog text**: - - **Keep it short**: 1–3 short lines describing the outcome (not implementation details). - - **Minimal examples only**: If an example helps, prefer a tiny snippet (typically import + 1 call). Avoid long blocks. - - **Breaking changes**: Include a tiny migration example using: - - `#### before` - - `#### after` -- **Split changesets by impact**: - - If **multiple packages are affected in different ways**, create **separate changesets** so each package’s changelog is focused. - - If the same change applies uniformly to multiple packages, a single changeset is fine. +Any user-facing change in a published package (`packages/*`) requires a changeset. Run `yarn changeset` from repo root. See skill "changeset" for format and full workflow.