diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c935a1665d3c..d12cda804156 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,23 @@ -Before submitting a pull request, please take a look at our -[Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md) guidelines and verify: + + +**Why:** + +**How to review:** + +**Unsure about:** + +Closes # + + diff --git a/AGENTS.md b/AGENTS.md index 71f47f9164af..42822b78762f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -60,9 +60,7 @@ Uses **Git Flow** (see `docs/gitflow.md`). ## Pull Requests -- **Do NOT add a "Test plan" / "Testing" checklist to PR bodies.** CI runs the full test suite on every PR — a hand-rolled checklist duplicates that signal and rots fast. Write the summary content directly and add a _Root cause_ section only if relevant. -- **Omit the "Summary" heading** in PR bodies — lead with the summary text itself, no `## Summary` header. -- Include `Fixes #` somewhere in the PR body so the merge auto-closes the linked issue. +- Use `.github/PULL_REQUEST_TEMPLATE.md` for the body (`gh pr create --body` skips it). Ideally 1-2 sentences per field, no AI walkthrough. - Always open PRs as draft. - **Keep PR descriptions condensed** — usually a few sentences. Explain the _reasoning_: why the change is needed, and any non-obvious decisions or tradeoffs made along the way. Do **not** walk through the implementation or describe what changed file-by-file — the diff already shows that. Only go longer when the decisions genuinely warrant it.