Agents: add PR description guidance on rationale over restatement#307
Merged
Merged
Conversation
ericholscher
commented
Jun 2, 2026
| - Use Django conventions and best practices | ||
| - Use type hints for function signatures | ||
| - Write clear, concise docstrings for public functions and classes | ||
| - Run linters and formatters using `tox -e pre-commit` before committing code |
Member
Author
There was a problem hiding this comment.
There were multiple mentions of pre-commit so removed this to make it explicit.
humitos
approved these changes
Jun 2, 2026
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
3 participants
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.
AGENTS.mdis copied into every production repo, so its PR section shapes every agent-written PR. The guidance was loose enough to produce bloated descriptions that just restate the diff — and, twice in this PR's own history, duplicate "generated by AI" footers. This sharpens that section to ask for the why over a restatement of the what, and fixes the footer rule so a second one never gets appended. A few stale lines in the surrounding text are corrected in passing.AGENTS.mdis the canonical copy and there's no separateCLAUDE.mdhere, so this is the only place to change.