agent-readiness-action

Imported from alipajand/agent-readiness-action (AGENTS.md). Install upstream with npx skills add alipajand/agent-readiness-action. Copyright stays with the author.

AGENTS — agent-readiness-action

This repository is a GitHub Action (TypeScript, bundled with @vercel/ncc) that audits a repository's readiness for AI coding agents. It bundles two engines as git submodules:

• vendor/agent-readiness-kit — the readiness score (runArk in src/runArk.ts)
• vendor/agent-context-doctor — instruction-file quality (runContextAudit in src/runDoctor.ts)

Consumers run the committed dist/index.js, so dist/ must always match the source.

Layout

Commands

git submodule update --init   # vendored engines
pnpm install
pnpm typecheck
pnpm test
pnpm build                    # rebuilds dist/ — commit the result

Run pnpm typecheck, pnpm test, and pnpm build before finishing, and commit dist/ whenever source, dependencies, or a submodule changed. CI fails when dist/ is stale.

Rules

• Do not add runtime downloads (npx, npm install, fetching engines) or network calls other than the GitHub API used for PR comments.
• Do not edit files under vendor/. Change the upstream repository, then move the submodule.
• Keep TypeScript below 7: ncc needs the TypeScript JS API.
• Treat everything from the audited repository as untrusted: escape it in Markdown, log it with logUntrusted, and keep file writes inside repo-path.

Ask before changing

• Token handling, permissions, or which comments the action edits (src/commentPr.ts)
• Input or output names and defaults in action.yml (they are a public contract)
• Adding dependencies
• The node24 runtime or release tags

Final report

When you finish, list the files you changed, the commands you ran and their results, the tests you added, whether dist/ was rebuilt, and anything left unfinished.