Skip to content

Commit 95bf754

Browse files
authored
internal: Improve AGENTS.md with CI, changesets, and targeted test info (#3777)
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
1 parent 70fddec commit 95bf754

File tree

2 files changed

+13
-23
lines changed

2 files changed

+13
-23
lines changed

AGENTS.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ Monorepo for `@data-client` npm packages.
2020

2121
**Test naming**: `*.node.test.ts[x]` (Node), `*.native.test.ts[x]` (RN), `*.test.ts[x]` (regular)
2222

23+
**Targeted tests**: `yarn test --selectProjects ReactDOM --testPathPatterns packages/react` (project names: `ReactDOM`, `Node`, `ReactNative`)
24+
25+
## CI
26+
27+
- **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.
28+
- **GitHub Actions** (`.github/workflows/`) — release (`changesets`), bundle size PR comments, benchmark regression detection.
29+
30+
## Changesets
31+
32+
Any user-facing change in `packages/*` requires a changeset. Core packages are version-linked (bumping one bumps all). See skill "changeset" for full workflow.
33+
2334
## File Organization
2435

2536
- **API definitions**: `src/resources/` within examples/apps
@@ -34,18 +45,7 @@ Monorepo for `@data-client` npm packages.
3445

3546
## Documentation Updates
3647

37-
**Update docs when changing public APIs** (anything exported from package entry points like `index.ts`).
38-
39-
**Always update docs for:**
40-
- Breaking changes (removing/changing signatures, properties, or behavior; deprecations)
41-
- New public APIs (classes, functions, methods, hooks, composables)
42-
- New options/parameters on existing APIs
43-
44-
**No docs needed for:**
45-
- Internal/private APIs (prefixed with `_`, not exported, or marked `@internal`)
46-
- Implementation-only changes
47-
48-
Update docs **in the same commit/PR** as code changes. For writing guidelines, see skill "packages-documentation"
48+
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.
4949

5050
## Integration Details
5151

packages/AGENTS.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,3 @@
11
## Changesets (release notes)
22

3-
- **When to add**: Any user-facing change in a published package (`packages/*`) should include a changeset.
4-
- **Command**: Run `yarn changeset` from repo root (run it once per distinct change).
5-
- **Terse changelog text**:
6-
- **Keep it short**: 1–3 short lines describing the outcome (not implementation details).
7-
- **Minimal examples only**: If an example helps, prefer a tiny snippet (typically import + 1 call). Avoid long blocks.
8-
- **Breaking changes**: Include a tiny migration example using:
9-
- `#### before`
10-
- `#### after`
11-
- **Split changesets by impact**:
12-
- If **multiple packages are affected in different ways**, create **separate changesets** so each package’s changelog is focused.
13-
- If the same change applies uniformly to multiple packages, a single changeset is fine.
3+
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.

0 commit comments

Comments
 (0)