Skip to content

docs(all): add AGENTS.md and update development guide - #203

Merged
fefi95 merged 3 commits into
mainfrom
docs/agents-md-and-development-guide
Nov 13, 2026
Merged

fefi95 merged 3 commits into
mainfrom
docs/agents-md-and-development-guide

Conversation

@fefi95

@fefi95 fefi95 commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Closes #190
Closes #194

Verified (Node 25.2.1 from .nvmrc, fresh clone, cold cache)

Command Result
npm install -g corepack && corepack enable ok, yarn --version → 4.1.0
yarn install --immutable ok, ~11 s
yarn compile / yarn lint / yarn test exit 0; ~6 s / ~17 s / ~6 s
yarn compile && yarn lint && yarn test exit 0, ~29 s
yarn check exit 0, ~21 s
cd packages/core && yarn test 399 passing, ~1 s
yarn why tar ok
yarn npm audit --all --recursive --severity high exit 1 today (existing high findings, e.g. @isaacs/brace-expansion); exit 0 means clean
yarn dedupe tar --check ok

Where the code disagreed with the issues

  • Corepack on Node 25: .nvmrc pins 25.2.1, which no longer bundles Corepack, so a bare corepack enable fails. development.md adds npm install -g corepack for Node 25+.
  • Commit scopes: there is no commitlint config in the repo. The scopes live only in the development.md table (plus per-package .releaserc.json rules), so AGENTS.md links to that table.
  • usePlugin(): it is defined in packages/core/src/main.ts and calls config.addPlugin in config/Config.ts. AGENTS.md describes both.
  • Lint: yarn lint prints react-native parse warnings but exits 0; AGENTS.md says to trust the exit code.
  • Audit: added --severity high (per task) and noted the exit code.

AGENTS.md is the only agent file on purpose: it is the cross-tool convention, and #190's original title also mentioned CLAUDE.md.

Stefani Castellanos and others added 2 commits October 16, 2026 09:06
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@fefi95
fefi95 marked this pull request as ready for review October 16, 2026 15:13
@fefi95
fefi95 requested review from rojasTob and suany0805 November 4, 2026 19:29

@rojasTob rojasTob left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @fefi95, this is a solid PR. I checked every reference in AGENTS.md against the branch:

  • Paths: expect.ts, usePlugin → config.addPlugin, Config.ts, release.yml all exist where it says.
  • Matcher and test snippets: they match NumberAssertion.ts and its test file line for line.
  • Merge setting: the repo really is squash-only.
  • Links: the #requirements and #scopes anchors work.
  • Scopes: the table matches the four packages and their .releaserc.json rules.

The corepack note for Node 25 is a good catch.

Verdict: Approve. A few small, non-blocking notes:

  1. CLAUDE.md is missing. #190 asks for a CLAUDE.md that points to AGENTS.md. As far as I know, Claude Code only reads CLAUDE.md, so Claude agents won't pick this file up on their own. A one-line CLAUDE.md containing @AGENTS.md would fix that and close #190 as written.
  2. The "Test rule" wording reads as if the gap is fixed, but it isn't. It says the suite once let a > → >= mutation pass. The .toBeGreaterThan tests still only use 3 vs 2 and 1 vs 2, with no equal-value case, so that mutation would still pass today. Either add the boundary case here or say "currently" instead of "once".
  3. Related bug, for a separate issue. toBeOdd uses this.actual % 2 === 1. Since -3 % 2 === -1, expect(-3).toBeOdd() fails. This is exactly the problem the new rule warns about, and the tests don't cover negative numbers. I'd open a follow-up rather than fix it in this PR.
  4. Nit: corepack enable now appears both in Requirements and in the install block. That's fine, just slightly repetitive.

@fefi95
fefi95 merged commit 824a4e5 into main Nov 13, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix stale contributor docs (Yarn 4, main branch, package scopes) Add an agent instruction file (AGENTS.md + CLAUDE.md)

2 participants