Say in every prompt that a completion summary is a PR description - #175
Merged
Merged
Conversation
DESIGN.md §8 already settles that a `done` summary "is written to read as a
PR description" — `voro pr` opens the pull request with that text as the body
— but the agent-facing prompts only gestured at it ("a PR-ready `--summary`"),
and the skill did not mention `--summary` at all. Agents returned one-liners
like "Implemented X, tests pass", which is the whole PR body the operator then
reviews against.
Every place an agent is told what a summary is now says the shape in a phrase:
the dispatch preamble's closing paragraph, the shared `REWORK_SUMMARY_SENTENCE`
(still demanding the point-by-point answer, still one constant so the message
and the preamble cannot drift), the `done` and `set --summary` help blocks, the
`done` warning and the `[incomplete report]` nudge when they name the missing
summary, the `voro-cli` skill's transitions block, and the copy-paste preamble
in docs/agent-integration.md, whose example was modelling the bad shape.
Nothing about when a summary is recorded moves, and summaries stay optional —
the wording describes the shape of one that is written.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/DESIGN.md§8 already settles that adonesummary "is written to read asa PR description" —
voro propens the pull request with that text as the body —but the agent-facing prompts only gestured at it ("a PR-ready
--summary"), andthe
voro-cliskill did not mention--summaryat all. Agents consequentlyreturned one-liners like "Implemented X, tests pass", which is the whole PR body
the operator then reviews against. This is a wording change: no schema, state
machine, or scoring moves, and nothing about when a summary is recorded moves.
Every place an agent is told what a summary is now says the shape, in a phrase or
a sentence:
crates/voro/src/dispatch.rs— the closing paragraph ofRETURN_PATH_PREAMBLE_TEMPLATEnow says the summary is the pull request'sdescription and to write it as one ("a short account of what changed and why
followed by how you verified it, not a status line").
REWORK_SUMMARY_SENTENCEsays the same and keeps its point-by-point demand("a PR body that answers that feedback point by point, one item per point"). It
stays a single shared constant, so the redispatch preamble's
{rework}blockand
rework_messagecannot drift. No new brace-wrapped text was introduced, sothe single-pass renderer is unaffected.
crates/voro/src/cli.rs— thedoneusage block and theset --summaryline in
HELP(which is whatvoro done --helpandvoro set --helpprint)describe
--summaryas the PR description; thedonewarning appends "thesummary is the PR description
propens the pull request from" only when thesummary is the missing half, and the
show[incomplete report]nudge saysthe same.
plugins/voro/skills/voro-cli/SKILL.md—--summaryadded to thedoneline in the transitions block, plus a sentence on the shape it takes. Edited
the plugin copy, per
CLAUDE.md.docs/agent-integration.md— the copy-paste preamble's example, which wasmodelling the bad shape (
--summary "Implemented X, tests pass"), now carriesplaceholder text that reads as a PR description, and the
donebullet matchesthe wording landed in the prompts.
Summaries stay optional — the new wording describes the shape of one that is
written, never that one must be.
docs/DESIGN.mdneeded no edit: §8 alreadylicenses all of this and nothing landed contradicts it.
Verification
dispatch.rsunit testpreamble_says_the_summary_is_the_pr_descriptionasserts the plain rendered preamble against
render_preamble; the existingpreamble_tells_a_redispatched_rework_to_answer_the_feedbackandthe_rework_message_carries_the_feedback_and_the_instructionwere extended soboth spellings —
render_preamble(…, rework = true)andrework_message(…)—assert the PR-description wording alongside the surviving "point by point".
Prose assertions match on whitespace-normalised text so a rewrap of the
hand-wrapped constants does not break them.
cli.rstesthelp_describes_a_summary_as_the_pr_description;done_warns_only_about_the_missing_halfnow also asserts the shape noteappears for the missing summary and not for a missing branch, and
a_partial_report_is_flagged_incomplete_in_list_and_showasserts the nudgenames the PR description.
cargo test --workspace(470 + 1 + 389 passing, 0 failed),cargo clippy --workspace --all-targets -- -D warnings, andcargo fmt --allare clean.