Make AGENT-README.md compliant with the agent-readme.md v0.1 spec #3

Merged

hannah-vernon merged 1 commit from feature/agent-readme-v0.1-compliance into dev

2026-07-08 17:15:49 -05:00

hannah-vernon commented

2026-07-08 17:11:43 -05:00

Owner

What does this PR do?

Brings the repository's agent guidance file into compliance with the AGENT-README.md v0.1 specification.

Renames agent-readme.md to the canonical AGENT-README.md.
Reauthors the content to the v0.1 convention:
- Optional colon-delimited metadata header (Agent-Readme: 0.1, Name, Updated, Languages).
- Recommended section order: Purpose, Setup & commands, Guardrails, Conventions, Architecture, Contacts, Changes.
- Purpose and Guardrails present; Guardrails placed directly after Setup & commands.
- Conventions split into non-negotiable facts and negotiable preferences.
- Repo-specific guardrails (protected dev/main, parse-before-commit, CRLF for .ps1, -WhatIf before real runs) rather than generic model-steering text.
Adds the adoption badge to README.md pointing at ./AGENT-README.md (badge is human-facing, so it lives in README.md, not the agent file).

How was this tested?

Confirmed the file is valid Markdown and headings appear in the recommended order.
Confirmed no other file referenced the old agent-readme.md name.

Checklist

Changes are focused - one logical change
Documentation is in sync (README badge added; agent file reauthored)
No new third-party dependencies
No commented-out code or debug leftovers

## What does this PR do? Brings the repository's agent guidance file into compliance with the [AGENT-README.md v0.1 specification](https://agent-readme.md/spec/). - Renames `agent-readme.md` to the canonical `AGENT-README.md`. - Reauthors the content to the v0.1 convention: - Optional colon-delimited metadata header (`Agent-Readme: 0.1`, `Name`, `Updated`, `Languages`). - Recommended section order: `Purpose`, `Setup & commands`, `Guardrails`, `Conventions`, `Architecture`, `Contacts`, `Changes`. - `Purpose` and `Guardrails` present; `Guardrails` placed directly after `Setup & commands`. - `Conventions` split into non-negotiable facts and negotiable preferences. - Repo-specific guardrails (protected `dev`/`main`, parse-before-commit, CRLF for `.ps1`, `-WhatIf` before real runs) rather than generic model-steering text. - Adds the adoption badge to `README.md` pointing at `./AGENT-README.md` (badge is human-facing, so it lives in `README.md`, not the agent file). ## How was this tested? - [x] Confirmed the file is valid Markdown and headings appear in the recommended order. - [x] Confirmed no other file referenced the old `agent-readme.md` name. ## Checklist - [x] Changes are focused - one logical change - [x] Documentation is in sync (README badge added; agent file reauthored) - [x] No new third-party dependencies - [x] No commented-out code or debug leftovers

hannah-vernon added 1 commit

2026-07-08 17:11:43 -05:00

Make AGENT-README.md compliant with the agent-readme.md v0.1 spec d08f61b913

Rename agent-readme.md to the canonical AGENT-README.md and reauthor it to the
v0.1 convention: add an optional metadata header, use the recommended section
order (Purpose, Setup & commands, Guardrails, Conventions, Architecture, Contacts,
Changes), place Guardrails directly after Setup & commands, and split Conventions
into facts and preferences. Add the adoption badge to README.md pointing at the file.

Ref: https://agent-readme.md/spec/

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>