Skip to content

docs(agents): PR bodies are PM-level — why/what only, no code detail#2042

Merged
devantler merged 2 commits into
mainfrom
claude/definition-pm-level-pr-bodies
Jul 3, 2026
Merged

docs(agents): PR bodies are PM-level — why/what only, no code detail#2042
devantler merged 2 commits into
mainfrom
claude/definition-pm-level-pr-bodies

Conversation

@devantler

@devantler devantler commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

🤖 Generated by the Daily AI Assistant

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.

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>
@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates AGENTS.md with a PR-body convention that requires a concise disclosure/Why/What/Fixes-or-Part-of structure and excludes detailed code, symbols, snippets, linter output, test details, and validation transcripts.

Changes

Documentation convention update

Layer / File(s) Summary
PR body convention rules
AGENTS.md
Adds a section requiring PM-style PR body text with disclosure → Why → What → Fixes/Part of links, limits content to merge-order gates, breaking-change/new-dependency flags, and operational notes, and applies the rule to both PR creation and PR body edits.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: botantler-1

Possible related PRs: devantler-tech/monorepo#1989

Poem:
A PR body now keeps it brief,
With why and what as the chief relief,
No code, no logs, just the merge-time cue,
And links to help the readers through.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the PR's main change to PR body guidance in AGENTS.md.
Description check ✅ Passed The description is directly related and accurately explains the updated PR body instructions.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/definition-pm-level-pr-bodies

Comment @coderabbitai help to get the list of available commands.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@devantler devantler marked this pull request as ready for review July 3, 2026 03:28
@devantler devantler merged commit ed9ed58 into main Jul 3, 2026
12 checks passed
@devantler devantler deleted the claude/definition-pm-level-pr-bodies branch July 3, 2026 03:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant