From 111f8c8b0f5df260b596ee9bf8a56c303bd1ae16 Mon Sep 17 00:00:00 2001 From: Rick van Dijk Date: Tue, 15 Sep 2026 16:31:48 -0700 Subject: [PATCH] Require PR bodies to use the template's exact headings The PR description style guidance described the template loosely, and two release PRs were opened with a different, ad-hoc section structure instead of the actual headings in PULL_REQUEST_TEMPLATE.md. Makes verbatim use of the template's headings an explicit hard requirement. Co-Authored-By: Claude Sonnet 5 --- AGENTS.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 3b211554..337546a5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -177,6 +177,15 @@ Keep public API changes additive and non-breaking where possible; breaking chang ### PR description style +**Hard requirement**: use the [PR template](.github/PULL_REQUEST_TEMPLATE.md)'s actual +section headings verbatim — `What kind of change does this PR introduce?`, `What is the +current behavior?`, `What is the new behavior (if this is a feature change)?`, `Does this +PR introduce a breaking change?`, `Recommendations for testing`, `Links to relevant +issues/docs`, and the `Checklist before submitting` with its exact four items. Do not +substitute a different structure (e.g. a generic "Description" / "Type of change" layout) +even for small or maintainer-authored PRs like release/version-bump PRs — every PR must +be created from the template file's own headings. + Fill out the [PR template](.github/PULL_REQUEST_TEMPLATE.md), but keep each section tight: - State what changed and why. Don't narrate your own editing process or explain why one obvious, in-scope edit was made alongside another (e.g. "also updated X because it references Y") — that's a given fact of the PR, not something a reviewer needs spelled out.