Repository navigation
Agents: tighten the pull request description rules - #339
Draft
ericholscher wants to merge 2 commits into
Draft
ericholscher wants to merge 2 commits into
ericholscher wants to merge 2 commits into
Conversation
Give the description a fixed order (problem, approach, what the reviewer must do), a length cap, and a scope rule so agents stop writing roadmap context and open questions into PR bodies. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019qNu2BuxS1RBohnVdGovpF
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019qNu2BuxS1RBohnVdGovpF
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.
🤖 Generated with Claude Code · session
The current rules say what a PR description should be about but not how long it should be or where it should stop, so agent-written descriptions still come out at 150–200 words with a paragraph of roadmap ("this is the first of several…"), links to unrelated PRs, and open questions left for the reviewer to answer. Two docs PRs on readthedocs.org this week needed a rewrite for exactly that, and the rewritten versions were half the length with nothing lost.
The new section keeps the existing rules and adds the three that bound the problem: a fixed order (problem, approach and what the diff doesn't show, what the reviewer has to do), a cap of about 120 words, and "describe only this PR". It also says to state a choice rather than ask about it, and moves the AI-generated note from a footer to the first line so reviewers see it before reading.
Once merged,
sync-agents.sh --applypushes it to the sibling repos.