Skip to content

Require PR bodies to use the template's exact headings #528

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

Merged
rickdijk merged 1 commit into from
Sep 15, 2026
Merged

Require PR bodies to use the template's exact headings #528

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down