fix(ce-pr-description): cap description size and add pre-apply preview#605
Merged
fix(ce-pr-description): cap description size and add pre-apply preview#605
Conversation
…mmits/Review sections Apply six guardrails to prevent verbose, reviewer-unfriendly descriptions on large PRs (most visible failure mode: 14 H3 subsections re-listing Summary content): - Rewrite Step 5 "Large" row to cap at ~100-150 lines, prefer Summary-level tables over subsection-per-mechanism, and warn against 10+ subsections. - Add Step 8b compression pass: cut Summary-duplicating sections, enumerated Commits lists, process-oriented Review sections, subsection explosions, and any body running 30%+ over the sizing target. - Add value-lead check: rewrite Summary openings that lead with mechanism. - Add "No Commits section" and "No Review / process section" writing principles so the compression pass has codified rules to cite. In ce-commit-push-pr: - Add steering-discipline guidance in Step 6 capping free-text steering at ~100 words so ce-pr-description isn't pushed toward exhaustive mode. - Insert a preview-and-confirm step into Step 7's existing-PR rewrite path so the user sees the title, first two Summary sentences, and total line count before the new body is applied (matches DU-3's pattern).
Clean up three compliance gaps flagged against plugins/compound-engineering/AGENTS.md:
- ce-pr-description Step 1: replace `2>/dev/null` probes with an exit-code
elif chain so runtime bash no longer suppresses stderr.
- ce-pr-description Step 9: update stale prose reference from
`git-commit-push-pr` to `ce-commit-push-pr`.
- ce-commit-push-pr and ce-commit: switch "If you are Claude Code" wording
to objective voice ("In Claude Code" / "On platforms other than Claude
Code") to match the writing-style rule against second person.
Stable/beta sync: ce-commit has no `-beta` counterpart; voice fix is
plugin-wide for consistency between the two commit-related skills.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 79a961da9f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…ser convention
The preview-and-confirm step in Step 7's existing-PR branch spelled out
"Use the platform's blocking question tool" inline, which bypassed the
skill's top-of-file "Asking the user" umbrella and omitted the
no-question-tool fallback. That left cross-platform runs able to stop
after generating {title, body_file} without ever applying the update.
Replace the inline instruction with "Ask the user (per the 'Asking the
user' convention at the top of this skill): ..." so the umbrella's tool
list and numbered-options fallback apply to the new prompt, matching
every other "ask" in this skill and satisfying the AGENTS.md
Cross-Platform User Interaction rule.
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
Large PRs were producing 145-200 line descriptions with 14+ H3 subsections that re-listed Summary content in more words — reviewers either burned through them or skipped past. This caps the Large tier at ~100-150 lines, adds a compression pass that removes the common inflation patterns, and inserts a preview-and-confirm step before
ce-commit-push-proverwrites an existing PR body.What changed
ce-pr-description, with guidance that steering is for framing, not an exhaustive scope dump.gh pr editis called. User can decline and pass steering back for a regenerate.Notes
Second commit is a compliance sweep against
plugins/compound-engineering/AGENTS.md: exit-code probes in place of2>/dev/nullince-pr-descriptionStep 1, a stalegit-commit-push-prprose reference, and objective-voice fixes ("In Claude Code" / "On platforms other than Claude Code") in bothce-commitandce-commit-push-pr. Same topic, so bundled.