fix(templates): keep the review form in the templates #152

Merged
claudiomaradonna merged 3 commits from fix/review-template into main 2026-10-20 17:20:45 +02:00
Collaborator

Why

AGENTS.md § Work folders has a work folder's documents follow the
templates in .agents/templates/, and the workflows guide says each
document is written from its template there. review-pr's review.md
was the one form left beside its skill, so a reader sent to the
templates did not find it. The check-issue review raised this.

What changed

  • The review form is now .agents/templates/review.md, shaped like the
    other templates: a Goal statement in the Brief's form, and Reviews,
    which now says where review-pr's own first finding goes.
    .agents/skills/review-pr/review.md is gone.
  • review-pr step 2 writes from the template and holds the question to
    the user when the goal or kind is unclear, since a procedure belongs
    in its skill.
  • The validator requires the template. The review-pr page links it,
    and the guide names drafts as the one document without a template.
  • A Review template migration in UPGRADING.md moves a repository's
    own changes to the old form into the template, or into step 2, and
    takes the place of the earlier migrations that name the old form.

What review-pr and post-review do is unchanged.

How to verify

  • bash tests/agent-config/document-templates.sh passes the new case
    "fails when the template lacks the review.md document template"; on
    main it fails as "unexpectedly valid".
  • grep -rn "review-pr/review.md" docs .agents prints nothing.
  • On the tip, bash tests/verify-agent-config.sh (266 passed),
    bash tests/check-work-folder.sh (46), .agents/hooks/shellcheck.sh repo, prettier --check '**/*.md', scripts/verify-agent-config.sh,
    and git diff --check main pass.
  • Not run: the behavioral evals, which the Maintenance section asks for
    before merging a skill or template change.
## Why AGENTS.md § Work folders has a work folder's documents follow the templates in `.agents/templates/`, and the workflows guide says each document is written from its template there. `review-pr`'s `review.md` was the one form left beside its skill, so a reader sent to the templates did not find it. The check-issue review raised this. ## What changed - The review form is now `.agents/templates/review.md`, shaped like the other templates: a Goal statement in the Brief's form, and Reviews, which now says where `review-pr`'s own first finding goes. `.agents/skills/review-pr/review.md` is gone. - `review-pr` step 2 writes from the template and holds the question to the user when the goal or kind is unclear, since a procedure belongs in its skill. - The validator requires the template. The `review-pr` page links it, and the guide names drafts as the one document without a template. - A Review template migration in `UPGRADING.md` moves a repository's own changes to the old form into the template, or into step 2, and takes the place of the earlier migrations that name the old form. What `review-pr` and `post-review` do is unchanged. ## How to verify - `bash tests/agent-config/document-templates.sh` passes the new case "fails when the template lacks the review.md document template"; on `main` it fails as "unexpectedly valid". - `grep -rn "review-pr/review.md" docs .agents` prints nothing. - On the tip, `bash tests/verify-agent-config.sh` (266 passed), `bash tests/check-work-folder.sh` (46), `.agents/hooks/shellcheck.sh repo`, `prettier --check '**/*.md'`, `scripts/verify-agent-config.sh`, and `git diff --check main` pass. - Not run: the behavioral evals, which the Maintenance section asks for before merging a skill or template change.
review-pr's review.md was the one work-folder document whose form sat
beside its skill, against AGENTS.md's rule that work folders follow
.agents/templates/. It is now .agents/templates/review.md, shaped as
the other templates, and the validator requires it. review-pr step 2
now holds the question to the user when a goal or kind is unclear,
since a procedure belongs in its skill.
The review-pr page links the review form's new home, and the guide
names the drafts as the one document without a template.
An upgrade from before the review template keeps the repository's own
changes to review-pr/review.md, moving them to the template or, for
the question to the user, to review-pr step 2, and takes the place of
the earlier migrations that name the old form.
claudiomaradonna deleted branch fix/review-template 2026-10-20 17:20:51 +02:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
claudiomaradonna/agent-foundry!152
No description provided.