Skip to content

chore: Use What/Why structure in PR template #26348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andreiborza merged 7 commits into from
Nov 13, 2026
+11 −15
Merged

chore: Use What/Why structure in PR template #26348

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ff8292f
chore: Restore previous PR template and agent PR rules
andreiborza Nov 13, 2026
fe9c578
Keep AGENTS.md PR rules unchanged
andreiborza Nov 13, 2026
38e3dbb
Use What/Why structure in PR template
andreiborza Nov 13, 2026
6609c08
Move general guidance to the top of the PR template
andreiborza Nov 13, 2026
b887fa3
Update .github/PULL_REQUEST_TEMPLATE.md
andreiborza Nov 13, 2026
df9efab
Keep the external contributor note in the PR template
andreiborza Nov 13, 2026
c647055
Merge remote-tracking branch 'origin/ab/revert-pr-template' into ab/r…
andreiborza Nov 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 11 additions & 15 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
<!--
Read the Contributing guidelines first: https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md

Before you request a review:

- Add tests for new or changed behavior. `pnpm run lint` and `pnpm run test` pass.
- Fix or dismiss AI review findings.
- 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. on small PRs).
- External contributors: link an issue where you got a maintainer's go-ahead.

@s1gr1d s1gr1d Nov 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should keep this line somewhere.

Use simple, direct sentences. No "Summary" heading, no test-plan checklist.
Remove "Closes" if there is no linked issue.
External contributors: link an issue where you got a maintainer's go-ahead.
-->

**Why:** <!-- reason behind change, why this approach (no implementation walkthrough), non-obvious decisions/tradeoffs -->
## What

**How to review:** <!-- where to start, what to skim -->
<!--
One or two sentences on what changed for users. Add one-line bullets for the changes if needed.
Describe behavior and intent, not implementation. Reviewers read the diff for the how.
-->

**Unsure about:** <!-- where you want a second opinion -->
## Why

Closes #
<!-- One or two sentences: reason behind change, why this approach (no implementation walkthrough), non-obvious decisions/tradeoffs -->

<!-- Long, AI-written descriptions at the end, inside `<details><summary>AI walkthrough</summary>...</details>` -->
Closes: #
Loading