Skip to content

AGENTS.md

Latest commit

 

History

History
11 lines (7 loc) · 1.17 KB

AGENTS.md

File metadata and controls

11 lines (7 loc) · 1.17 KB

AGENTS.md

Contributor conventions for this repo live in CONTRIBUTING.md. Read it end-to-end before opening a PR. This file only highlights what reviewers and automation will not fix for you.

Failure modes that most often trip agents here:

  • Forgetting pnpm changeset. Pull requests that touch codemods/ should include a changeset covering each changed package (or the skip-changeset label). CI warns but does not fail when changesets are missing. See Adding a changeset in CONTRIBUTING.md.
  • Editing version in codemod.yaml by hand. The version field in codemod.yaml is synced automatically from package.json by scripts/sync-codemod-versions.sh when pnpm run version-packages runs. Only edit version in package.json (via changesets). See Release workflow in CONTRIBUTING.md.
  • Skipping local checks. Run pnpm run format, pnpm run lint, and pnpm run ci before you call the task done. See Development setup and CI in CONTRIBUTING.md.

Before declaring a task done, confirm layout and naming under Adding a new codemod and Package shape in CONTRIBUTING.md, and update fixtures whenever behavior changes.