Commit dba5cd1
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
0 commit comments