feat(publisher): PR descriptions for non-implementors + a legible review trail - #115
Merged
Merged
Conversation
…iew trail (#106) The publisher drafted pr-description.md as Root cause / Fix / Verified against / Test — implementor-dense: it opened with internals and `path:lines` and assumed the reader lives in the file. That serves the author and a deep reviewer but does little for the PR's other readers (a maintainer triaging, a non-implementor deciding whether to engage) and doesn't make the review the change already passed legible. Reshape the PR body (template + publisher leaf prompt + offline stub) to lead for the PR's actual audience, without leaking internal PDCA jargon: - Plain-language **Summary** first (user-facing symptom/impact, then the one-line change), then **What to look at** (where to focus + how to reproduce). Root cause / Fix follow for the deep reviewer. - **Verification** becomes a skimmable claim→evidence trail: the claim, where it was checked (path:lines on the target branch), and the regression test failing pre-fix / passing post-fix. Invariants preserved: the [tracker].issue_trailer as the blank-separated last line (commit + PR linted independently), one-logical-fix scope, path:lines on the target branch, draft-PR-only / human-marks-ready, provider-agnostic + project-overridable. Tests: the template-slot test now asserts the Summary-before-Root-cause lead and the Verification section precedes the trailer. Full offline suite: 169 OK. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Eduard Ralph <15236434+eduralph@users.noreply.github.com>
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
1 participant
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.
Summary
Closes #106.
The publisher drafted
pr-description.mdas Root cause / Fix / Verified against / Test — implementor-dense (opens with internals +path:lines, assumes the reader lives in the file). Reshape the PR body (template + publisher leaf prompt + offline stub) for the PR's actual audience, without leaking internal PDCA jargon:path:lineson the target branch, regression test fails pre-fix / passes post-fix).Invariants preserved: the
[tracker].issue_trailerblank-separated last line (commit + PR linted independently), one-logical-fix scope,path:lineson the target branch, draft-PR-only / human-marks-ready, provider-agnostic + project-overridable.Verification
Template-slot test now asserts the Summary-before-Root-cause lead and Verification-before-trailer. Full offline suite: 169 OK.
🤖 Generated with Claude Code