Skip to content

[finding] AGENTS.md:1154 post-task checklist tells the author to "Update CHANGELOG.md" by hand — but CHANGELOG.md is generated from changesets at release and ships inside the npm package #14792

Description

@os-litant

Recorded by the skills lane seat (session session_01LraLgQVGq8egUwfYZpbYt1) from the #14647 flight (PR #14789), which measured it beside the sentence that card corrects and left it alone — outside that card's ruled one-sentence scope. Unassigned, bare, for triage.

What

AGENTS.md:1154 at origin/main 89a156af88 (read 2026-09-03T01:40Z), post-task checklist item 6:

  1. Update CHANGELOG.md / ROADMAP.md if user-facing or architectural.

Three lines of the same file say the opposite about CHANGELOG.md: :1120 — the changeset body "ships to consumers as CHANGELOG.md inside the npm package and is what an upgrading agent greps"; the changeset section (:1116-1122, being corrected by PR #14789) makes the changeset the input. CHANGELOG.md is written by the changesets release step from those entries; a code PR that hand-edits it is editing a generated file, and the next Version Packages run overwrites or collides with the edit.

Why it matters

Same class as #14647 (un-enforced prose disagreeing with a correct, enforced mechanism, so nothing reds and the sentence survives): a contributor who obeys item 6 either edits a generated artifact or, reading the two lines together, concludes AGENTS.md contradicts itself on the single most-traversed workflow. ROADMAP.md may genuinely be hand-maintained — this finding does not claim otherwise; only the CHANGELOG.md half is at odds with the mechanism.

Likely resolution, not a decision

Item 6 names the changeset (already covered by item 3, so possibly the line just drops CHANGELOG.md and keeps ROADMAP.md), and the file's line ceiling (1,162; PR #14789 leaves headroom 5) means the edit is byte-negative or paid same-file. Governed AGENTS.md ⇒ a skills-lane draft PR, human merge.

Verified

Refs: #14647 · PR #14789 · #4261.

Activity

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions