docs: keep the generic PR template as a deliberate org default - #73
Merged
Conversation
lesnik512
force-pushed
the
docs/keep-generic-pr-template
branch
from
September 6, 2026 17:15
82cbcc9 to
fdde623
Compare
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
The org default PR template is inherited by every repo without a local one, and its
checklist carries
Docs updated if behavior or public API changed. That is thepre-convention question, the one this org stopped asking: it prompts for a page
update rather than the admission check, and it is untrue for any repo where behaviour
detail lives in
INVARIANT:tests rather than prose.Separately, this file opens by claiming its conventions apply across all repos in the
org. They do not.
AGENTS.mdis not a GitHub default community health file, so it isnever inherited, and no other repo's
AGENTS.mdreferences this one. An agent readsexactly the file in the checkout it is standing in.
Design
Keep the template as the org default and delete the one untrue line. What remains
(lint, type check, tests, build, metadata) holds under either convention, so the
inherited form is correct everywhere for the first time.
AGENTS.mdloses three lines and gains none. The opening claim goes, and nothingreplaces it: an agent reading this file is already standing in this repo and cannot
act on a statement about repos it will never see. The heading follows, becoming
# modern-python/.githubto matchCONTEXT.md, since "org conventions" asserts thesame reach the paragraph just gave up.
The Workflow blockquote goes for the same reason. It existed to explain why the
template contradicts the convention, to an agent that opens a PR with
gh pr create --bodyand never reads the template. Its one actionable clause, "writePR bodies in the shape above", is the paragraph directly above it.
Non-goals
modern-di,faststream-outboxandchat-app. Deletedin their own PRs; this one only makes the default they fall back to correct.
that-depends. Keeps its local template, which is the only one in the orgmeasurably in use.
it to the other repos; removing it here would change this repo's own practice and is
a separate call.
CONTEXT.md:8, which repeats the org-wide claim just deleted here. It needs thesame fix and is mid-edit on another branch.
Verification
uv run pytest: 123 passed, 26 skipped, 5 failed. All five failures are PNGrendering (
test_lockups,test_pngopt,test_projects) and reproduce unchanged onmain—rsvg-convertandpngquantare not installed locally. CI installs them(#62). This change touches no Python.
Part of #53.