Skip to content

Agents: keep the PR description in sync with the branch #309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ericholscher wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Agents: keep the PR description in sync with the branch #309

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e967825
Agents: add PR description guidance on rationale over restatement
claude Jun 2, 2026
570322c
Agents: fix typo and clarify PR description wording
claude Jun 2, 2026
b6d9520
Agents: avoid duplicate AI-generated footer in PRs
claude Jun 2, 2026
3fbedfb
Agents: fix Python version and dedupe pre-commit guidance
claude Jun 2, 2026
96306c9
Agents: trim boilerplate that agents already follow
claude Jun 2, 2026
29afb19
Agents: require keeping the PR description in sync with the branch
claude Jun 2, 2026
cecb589
Merge origin/main and resolve AGENTS.md conflict
Copilot Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ It supports multiple documentation tools (Sphinx, MkDocs, etc.) and automaticall
* Note in a footer that the PR was generated by an AI agent, but only if no such footer is already appended automatically — never add a second one
* Use feature branches for all changes
* Write the description about *why*: the problem it solves, the approach taken, and anything a reviewer should double-check. Don't restate *what* changed — no "Changes" section, changelog, file lists, or per-change bullets — since the diff already shows that. Prefer "Sharpens the PR rules, which kept producing diff-restating descriptions" over "Reworded one bullet, fixed a typo, removed two sections."
* Keep the description in sync with the branch. When later commits add, drop, or rework what the PR does, update the description before review or merge — a stale description that describes a different change is worse than none.
* Don't include Test Plan unless absolutely necessary.
* Link related issues in the PR description, if there are any in the chat context
* Prefix pull request titles, example `Api:`, `Builds:`, or `Docs:`.
Expand Down