Skip to content

internal: Improve AGENTS.md with CI, changesets, and targeted test info #3777

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
ntucker merged 1 commit into from
Mar 8, 2026
Merged

internal: Improve AGENTS.md with CI, changesets, and targeted test info #3777

Show file tree
Hide file tree
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
24 changes: 12 additions & 12 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
12 changes: 1 addition & 11 deletions packages/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.