docs(templates): clarify the medium severity clause #141

Merged

claudiomaradonna merged 1 commit from docs/report-template-typo into main

2026-10-19 10:11:57 +02:00

motoko commented

2026-10-18 22:12:57 +02:00

Collaborator

Why

In the report template's severity scale, the medium clause reads "medium when a reader would stop to ask, such a goal's check holds only in part, or it is needless code, text, or duplication". That is a list of three conditions, but the second one reads like an example with a missing "as". One reviewer reported it as a typo, and this change first fixed it as one. Adding "as" would have made that condition an example of the first and changed the scale.

What changed

Each condition starts with "when". None of the three now reads as an example of another, and each means what it meant before. "Such a goal" still refers back to the high clause's goal.
The paragraph is rewrapped to 72 columns, from the clause to its end. No other word changes.

How to verify

git diff --word-diff=plain main adds only the two "when"s.
tr '\n' ' ' < .agents/templates/report.md | grep -c "when such a goal's check holds only in part, or when it is needless" prints 1 here and 0 on main.

These pass on the tip: bash tests/verify-agent-config.sh (257), 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. The behavioral evals were not run, since a two-word change to a template gives them nothing to measure.

## Why In the report template's severity scale, the medium clause reads "medium when a reader would stop to ask, such a goal's check holds only in part, or it is needless code, text, or duplication". That is a list of three conditions, but the second one reads like an example with a missing "as". One reviewer reported it as a typo, and this change first fixed it as one. Adding "as" would have made that condition an example of the first and changed the scale. ## What changed - **Each condition starts with "when".** None of the three now reads as an example of another, and each means what it meant before. "Such a goal" still refers back to the high clause's goal. - **The paragraph is rewrapped** to 72 columns, from the clause to its end. No other word changes. ## How to verify - `git diff --word-diff=plain main` adds only the two "when"s. - `tr '\n' ' ' < .agents/templates/report.md | grep -c "when such a goal's check holds only in part, or when it is needless"` prints 1 here and 0 on main. These pass on the tip: `bash tests/verify-agent-config.sh` (257), `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`. The behavioral evals were not run, since a two-word change to a template gives them nothing to measure.

motoko added 1 commit

2026-10-18 22:13:03 +02:00

docs(templates): clarify the medium severity clause e11a58ba9f

The medium clause lists three conditions, but its second, "such a
goal's check holds only in part", read as an example missing "as".
Repeat "when" before each condition, and rewrap the paragraph.

claudiomaradonna merged commit e11a58ba9f into main

2026-10-19 10:11:57 +02:00

claudiomaradonna deleted branch docs/report-template-typo

2026-10-19 10:12:00 +02:00

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!141

No description provided.

Rows
Columns