claudiomaradonna/agent-foundry
claudiomaradonna/agent-foundry
Template
1
0
Fork 0
Code Issues Pull requests Activity Actions

style(templates): rewrap the templates' comments #176

Merged
claudiomaradonna merged 1 commit from fix/template-comments-wrap into main 2026-10-29 21:28:21 +01:00
Conversation 0 Commits 1 Files changed 7 +110 -85
motoko commented 2026-10-29 21:26:44 +01:00
Collaborator
Copy link

Why

Prettier fills the source's prose to 72 columns but leaves text inside
HTML comments as written, so the guiding comments of six templates under
.agents/templates/ had paragraphs broken short, as #171 found in the
pull request template; every adopting repository inherits them, and
nothing kept a later edit from leaving more. Waiving a test, as #171
did, was set aside, as the same defect came back the same day.

What changed

The comments of diagnosis.md, report.md, review.md, skill.md,
verdict.md, and work.md read as Prettier fills prose; no word or
list item changes, and lines Prettier cannot break, a frontmatter
example, a heading, and a code span, stay as they were. A new check in
tests/agent-config/document-templates.sh runs Prettier once over every
template comment and fails naming each one it would change; it prints a
skip line where Prettier is missing.

How to verify

On the branch, run bash tests/agent-config/document-templates.sh: it
ends with all 9 agent configuration tests passed. Then restore main's
templates with git checkout main -- .agents/templates and run it
again: it fails with "fills each document template's comments as
Prettier fills prose" and names the 15 ragged comments, such as
work.md:40.md. git diff --word-diff main shows no changed word.

The source's Maintenance checks pass on the tip:
bash tests/verify-agent-config.sh (329 passed),
bash tests/check-work-folder.sh, .agents/hooks/shellcheck.sh repo,
prettier --check '**/*.md', scripts/verify-agent-config.sh, and
git diff --check main. The behavioral evals were not run, as each run
is billed.

## Why Prettier fills the source's prose to 72 columns but leaves text inside HTML comments as written, so the guiding comments of six templates under `.agents/templates/` had paragraphs broken short, as #171 found in the pull request template; every adopting repository inherits them, and nothing kept a later edit from leaving more. Waiving a test, as #171 did, was set aside, as the same defect came back the same day. ## What changed The comments of `diagnosis.md`, `report.md`, `review.md`, `skill.md`, `verdict.md`, and `work.md` read as Prettier fills prose; no word or list item changes, and lines Prettier cannot break, a frontmatter example, a heading, and a code span, stay as they were. A new check in `tests/agent-config/document-templates.sh` runs Prettier once over every template comment and fails naming each one it would change; it prints a skip line where Prettier is missing. ## How to verify On the branch, run `bash tests/agent-config/document-templates.sh`: it ends with `all 9 agent configuration tests passed`. Then restore main's templates with `git checkout main -- .agents/templates` and run it again: it fails with "fills each document template's comments as Prettier fills prose" and names the 15 ragged comments, such as `work.md:40.md`. `git diff --word-diff main` shows no changed word. The source's Maintenance checks pass on the tip: `bash tests/verify-agent-config.sh` (329 passed), `bash tests/check-work-folder.sh`, `.agents/hooks/shellcheck.sh repo`, `prettier --check '**/*.md'`, `scripts/verify-agent-config.sh`, and `git diff --check main`. The behavioral evals were not run, as each run is billed. 
Prettier leaves text inside HTML comments as written, so paragraphs in
the comments of six templates stayed short of the 72-column fill, as
#171 found in the pull request template. Rewrite each comment's text as
Prettier fills it, words and list items unchanged, and add a test that
runs Prettier over each template comment, skipped where Prettier is
missing, so the comments stay filled.
claudiomaradonna deleted branch fix/template-comments-wrap 2026-10-29 21:28:24 +01:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
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!176
No description provided.