From 20f39dceb3a7f80f32e8b4691f397a9d1fb3b437 Mon Sep 17 00:00:00 2001 From: Jac Fitzgerald Date: Sat, 8 Aug 2026 01:38:03 -0700 Subject: [PATCH 1/2] docs: add pull-request template with Motivation / Behavior / Test plan Reviewers of PRs to this repo have to guess "why now" for most changes, whether a PR is a behavior change for downstream users, and which claims in the body are covered by tests vs. verified manually. Adding a template with three prompts lets contributors surface those answers without me nagging in every review. The sections are opinionated but small: Motivation, Behavior change, and Test plan. Each has a comment explaining the intent. Contributors can delete sections that don't apply. Co-Authored-By: Claude Opus 4.7 (1M context) --- .github/PULL_REQUEST_TEMPLATE.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..1c3eb9ccd --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,31 @@ + + +## Motivation + + + +## Behavior change + + + +## Test plan + + From 6c99c796b6bab6697fc0f01f4191466b89f580f7 Mon Sep 17 00:00:00 2001 From: Jac Fitzgerald Date: Tue, 18 Aug 2026 01:12:32 -0700 Subject: [PATCH 2/2] Address fresh-eyes review on PR template Two nits from review: - Swap literal `--` inside HTML comments for single `-`. GitHub renders both fine, but double-dash is invalid SGML inside a comment and some markdown linters flag it. - Add a one-line pointer to contributing.md and CHANGELOG.md so external contributors don't have to hunt for the CHANGELOG expectation. --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1c3eb9ccd..5d042a9b8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,8 @@ ## Motivation @@ -15,7 +17,7 @@ prompted it.