Commit 4c99cc7
chore: Add pull request template (#1091)
## Why
Ad-hoc — PR descriptions here are mostly AI-written prose. The template
encodes the team PR guidelines at the point where the description gets
written: agents get a lane, and one section is reserved for the human
author.
## What changed
Adds `.github/pull_request_template.md`. GitHub auto-loads it into the
description box on every new PR; agents read the same file when drafting
bodies. All prompts are HTML comments — visible in the edit box,
invisible in the rendered PR.
Sections, modeled on the strongest real PR descriptions in this repo and
apify-core (evidence-based why, Before/Now for small fixes,
reviewer-effort calibration, screenshot/staging proof):
- **Why** — issue link, or ad-hoc as the exception with the problem
stated; evidence beats adjectives.
- **What changed** — Before/Now is enough for a small fix; no file
lists; approach rationale only when non-obvious.
- **Notes for reviewers (human-written)** — where to look hardest, what
the author is unsure about, which parts AI wrote that they don't fully
follow, impact on `apify-mcp-server-internal`. Agents are told to leave
it empty; an empty or agent-prose section is visible at a glance.
- **Proof it works** — e2e mcpc probe, screenshot, or platform run link.
Not "unit tests pass" (CI shows that); not "the AI said it works".
## Notes for reviewers (human-written)
Open for discussion :)
## Proof it works
No proof yet
---
_Generated by [Claude
Code](https://claude.ai/code/session_01FkU9wM2H2N1dNYVRdoRhzp)_
---------
Co-authored-by: Claude <noreply@anthropic.com>1 parent a387a2d commit 4c99cc7
1 file changed
Lines changed: 17 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 | + | |
0 commit comments