Skip to content

copilot-instructions says AGENTS.md has no repository-specific content, and every AGENTS.md preamble is exactly that #738

Description

@ptr727

.github/copilot-instructions.md tells a reviewer what it may and may not edit:

AGENTS.md is the thin router and carries three byte-locked sections of its own, with no repository-specific ones.

True of the sections, and misleading about the file. Every AGENTS.md in the fleet, this repository's included, carries a preamble above the first ## heading that is entirely its own: what the repository is, and which local doc owns which subject. Here that is the "ProjectTemplate exists for agent enablement across a fleet of related projects" paragraph and the two that follow it.

The sentence exists so a reviewer knows what is safe to flag and what a local edit would break, so being read as "none of AGENTS.md is editable" is exactly the failure it should prevent. Copilot raised it against a carried copy on ptr727/ESPHome-Config#94, as a suppressed low-confidence finding, and it was right.

Naming the three sections and stating that the preamble is the repository's own would fix it, along the lines of:

AGENTS.md is the thin router and carries three byte-locked sections of its own, Fleet Bootstrap, Context and Delegation Discipline, and Where the Rules Live. Everything above the first of those headings is this repository's own prose, saying what this repository is and which local doc owns which subject, and it is editable like any other repository content.

Applied downstream in that pull request, since the file is intent fidelity and a carried copy that misdescribes its own repository is the thing intent fidelity exists to let a repository correct. Filing it here because the sentence is inaccurate in every copy rather than in that one.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions