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

style(templates): rewrap pull-request.md's comments #174

Merged
claudiomaradonna merged 1 commit from fix/pr-template-wrap into main 2026-10-29 20:27:19 +01:00
Conversation 0 Commits 1 Files changed 2 +18 -20
motoko commented 2026-10-29 20:00:37 +01:00
Collaborator
Copy link

Why

Prettier fills the source's prose to 72 columns but leaves text inside
HTML comments as written, so three paragraphs in the pull request
template's comments stayed short of the fill, the ## Why one broken at
30 columns. Every repository that adopts the template, and its Forgejo
copy, inherits the ragged text. Fixes #171, widened from the ## Why
paragraph the issue names to every comment paragraph of the same file.

What changed

The comments of .agents/templates/pull-request.md and
.forgejo/pull_request_template.md read as filled paragraphs; no word
changes, and the two files stay identical.

How to verify

On the branch, run this check of every comment paragraph, which prints
each line that could take the next line's first word within 72 columns:

awk '/^<!--/ { c = 1; prev = ""; next } /^-->/ { c = 0; prev = ""; next } c { if ($0 == "") { prev = ""; next } split($0, w, " "); if (prev != "" && length(prev) + 1 + length(w[1]) <= 72) print NR - 1 ": " prev; prev = $0 }' .agents/templates/pull-request.md

It prints nothing; on main it prints lines 5, 14, 17, and 29.
git diff --word-diff main shows no changed word.

The source's Maintenance checks pass on the tip:
bash tests/verify-agent-config.sh (319 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.

## Why Prettier fills the source's prose to 72 columns but leaves text inside HTML comments as written, so three paragraphs in the pull request template's comments stayed short of the fill, the `## Why` one broken at 30 columns. Every repository that adopts the template, and its Forgejo copy, inherits the ragged text. Fixes #171, widened from the `## Why` paragraph the issue names to every comment paragraph of the same file. ## What changed The comments of `.agents/templates/pull-request.md` and `.forgejo/pull_request_template.md` read as filled paragraphs; no word changes, and the two files stay identical. ## How to verify On the branch, run this check of every comment paragraph, which prints each line that could take the next line's first word within 72 columns: ```bash awk '/^<!--/ { c = 1; prev = ""; next } /^-->/ { c = 0; prev = ""; next } c { if ($0 == "") { prev = ""; next } split($0, w, " "); if (prev != "" && length(prev) + 1 + length(w[1]) <= 72) print NR - 1 ": " prev; prev = $0 }' .agents/templates/pull-request.md ``` It prints nothing; on main it prints lines 5, 14, 17, and 29. `git diff --word-diff main` shows no changed word. The source's Maintenance checks pass on the tip: `bash tests/verify-agent-config.sh` (319 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`. 
Prettier leaves text inside HTML comments as written, so three
paragraphs of the pull request template's comments, the Why one broken
at 30 columns, stayed short of the 72-column fill. Rewrap them, words
unchanged, in the template and its Forgejo copy, which a test keeps
identical.

Fixes #171
motoko force-pushed fix/pr-template-wrap from adb57ee394 to 71827817a2 2026-10-29 20:13:07 +01:00 Compare
claudiomaradonna deleted branch fix/pr-template-wrap 2026-10-29 20:27:23 +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!174
No description provided.