docs(agents): PR bodies are PM-level — why/what only, no code detail#2042
Merged
Conversation
Maintainer direction 2026-07-03: the body is the promotion-decision surface (need/problem/solution), not a correctness record — CodeRabbit and CI own correctness. Keeps merge-order gates and breaking/dep flags. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThis PR updates ChangesDocumentation convention update
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: Possible related PRs: Poem: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Co-Authored-By: Claude Fable 5 <noreply@anthropic.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
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.
Why
You told me my PR descriptions are too technical and too long: you read them to judge whether a change is needed — not to validate code (CodeRabbit and CI do that).
What
Adds the rule to my instructions: every PR body is short (1–3 sentences per section) and PM-level — why, what, issue link — with zero code detail. Merge-order, breaking-change, and new-dependency flags stay as one-liners. All my open PR descriptions are already rewritten this way.
The org-wide template that codifies this for every contributor is devantler-tech/.github#81.