From d12e563f80bbdc8aba6632c1d7df4b3ac75d8517 Mon Sep 17 00:00:00 2001 From: s1gr1d <32902192+s1gr1d@users.noreply.github.com> Date: Tue, 27 Oct 2026 15:05:33 +0100 Subject: [PATCH 1/2] chore: Update PR template and prompt agent to use it --- .github/PULL_REQUEST_TEMPLATE.md | 27 +++++++++++++++++++++------ AGENTS.md | 4 +--- 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fd24adc2207a..f182ea5e2cbf 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/master/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. From 8fd07b19507a211a3488896ef55c12ce6717f7d5 Mon Sep 17 00:00:00 2001 From: Sigrid <32902192+s1gr1d@users.noreply.github.com> Date: Tue, 27 Oct 2026 18:06:58 +0100 Subject: [PATCH 2/2] Apply suggestion from @s1gr1d --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 121e1e560f5e..d12cda804156 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,7 +8,7 @@ Before you request a review: - Read your own diff first, add inline comments with explanation or where to look closely. - Large PR? Split or stack it, or describe why you cannot. -- Remove fields that do not apply (e.g. small PRs). +- Remove fields that do not apply (e.g. on small PRs). - External contributors: link an issue where you got a maintainer's go-ahead. -->