Skip to content

Commit dba5cd1

Browse files
jacalataclaude
andauthored
docs: add pull-request template with Motivation / Behavior / Test plan (#1856)
* 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) <noreply@anthropic.com> * 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. --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 58e6fd9 commit dba5cd1

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!--
2+
Delete sections that don't apply. The prompts are here to make review
3+
faster, not to add ceremony - one sentence per section is often enough.
4+
See contributing.md for background; add a bullet to CHANGELOG.md under
5+
Unreleased for any user-visible behavior change.
6+
-->
7+
8+
## Motivation
9+
10+
<!--
11+
Why now. Link the issue, incident, user report, or parent PR. If this
12+
is preparation for another change, name it. If it's cleanup, say what
13+
prompted it.
14+
-->
15+
16+
## Behavior change
17+
18+
<!--
19+
For users of the library or CLI: what changes in observable behavior?
20+
"None - refactor only" is a valid answer. If a public symbol, endpoint
21+
signature, exception type, or return value shape changes, call it out
22+
here and in the CHANGELOG so downstream code isn't surprised.
23+
-->
24+
25+
## Test plan
26+
27+
<!--
28+
What's exercised by the tests in this PR. If any behavior claim in the
29+
description ISN'T covered by a test (e.g. "verified manually against a
30+
live server", "matches server behavior at REST endpoint X"), say so
31+
explicitly so reviewers know what's on trust vs. what regression tests
32+
will catch.
33+
-->

0 commit comments

Comments
 (0)