Skip to content

AGENTS.md: the dependency lockstep bullet and the npm test annotation are stale #4924

Description

@cliffhall

Found while writing the knowledge skills (#4872, PR #4921). Two statements in AGENTS.md no longer match the repository, and AGENTS.md says of itself that every rule in it is true of the repository as it stands.

1. Dependencies: the shared-devDependency bullet contradicts the guard

AGENTS.md → Dependencies says:

When you bump a devDependency that several TypeScript workspaces declare (typescript, vitest, @vitest/coverage-v8, @types/node, …), bump it in every workspace that declares it. Their ranges already differ; do not widen the skew.

Since #4864, npm run verify:dep-lockstep (in validate:guards, so in CI) fails when two declarations of a package in SHARED_DEV_DEPENDENCIES (typescript, vitest, @vitest/coverage-v8, prettier, @types/node) carry different ranges. The ranges no longer differ, and "do not widen the skew" understates a rule that is now "one range everywhere it is declared". The local-dev skill describes the guard, so an agent gets a different instruction depending on whether the skill loaded. Copilot raised this on PR #4921 (round 3).

Expected: the bullet states the lockstep rule the guard enforces and names the guard.

2. Development setup: npm test is annotated "with coverage"

The command block says:

npm test -w src/<server>                # one workspace (vitest, with coverage)

Each workspace's test script is vitest run. Coverage is the separate coverage script (vitest run --coverage).

Expected: the annotation drops "with coverage", or the block lists npm run coverage -w src/<server> on its own line.

Not included

The Before pushing paragraph saying CI does not run ruff check is also stale (python.yml runs scripts/validate-py.mjs, which does), but #4871's PR rewrites that section, so it is left to that change.

Branch

Targets v2/main. If #4871's PR is still open when this is picked up, check whether it already touched either line.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent guidanceRules, skills, and quality gates for agentsdocumentationImprovements or additions to documentationv2

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions