Skip to content

AGENTS.md: cover package updates and changes to the checks or the contract docs - #85

Merged
MyPrototypeWhat merged 1 commit into
mainfrom
docs/agents-maintainer-guide
Oct 26, 2026
Merged

MyPrototypeWhat merged 1 commit into
mainfrom
docs/agents-maintainer-guide

Conversation

@MyPrototypeWhat

@MyPrototypeWhat MyPrototypeWhat commented Oct 26, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

AGENTS.md only covered adding a package; updating a package got a single sentence. This adds two branches agents already take here:

  • Updating a package (step 1): keep the plugin ID, raise version, and call out a newly declared field that raises the minimum client version, since it drops older clients.
  • New section "Change the checks or the docs", limited to conventions not visible from the files themselves:

The opening line now points to the new section.

Left out on purpose:

  • the directory layout, which ls shows;
  • the per-package size limits, which npm run check enforces and docs/package-contract.md documents.

Verification

  • Every path and name in the new section exists:
    • each scripts/lib/rules/*.mjs has a test/<rule>.test.mjs;
    • all six docs/*.md carry a Verified against line;
    • package.json has no dependencies.
  • npm run check: 87 tests pass, including the wording test, which scans AGENTS.md.

View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

…contract docs

AGENTS.md described only adding or updating a package, and the update path was one sentence.
Two branches agents already take were missing:

- Updating a package: keep the plugin ID, raise version, and call out a newly declared field
  that raises the minimum client version, since it drops older clients.
- Changing the checks or the docs: minimum versions come from the first released client, not a
  preview build (#59 recorded 3.1.4 from a preview; the released 3.1.4 rejects the field, fixed
  in #81); contract, rule, test, and docs change together; the checker stays dependency-free; a
  new error must keep existing packages at zero errors because CI validates all of them; and
  contract changes go in their own PR.

Assisted-by: Claude Opus 5.5 (OpenCode)
@MyPrototypeWhat
MyPrototypeWhat merged commit 1ff1253 into main Oct 26, 2026
1 check 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.

1 participant