Skip to content

chore: Update PR template and prompt agent to use it #25763

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
s1gr1d merged 3 commits into from
Oct 27, 2026
Merged

chore: Update PR template and prompt agent to use it #25763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d12e563
chore: Update PR template and prompt agent to use it
s1gr1d Oct 27, 2026
5c93211
Merge branch 'develop' into sig/update-pr-template
s1gr1d Oct 27, 2026
8fd07b1
Apply suggestion from @s1gr1d
s1gr1d Oct 27, 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
27 changes: 21 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
<!--

@s1gr1d s1gr1d Oct 27, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Everything that's not actually a template, but a "check this first" is now within a comment so it's clear what's the template and what is just some extra text.

Read the Contributing guidelines first: https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md

- [ ] If you've added code that should be tested, please add tests.
- [ ] Ensure your code lints and the test suite passes (`pnpm run lint`) & (`pnpm run test`).
- [ ] Link the related issue. External contributors need a maintainer's go-ahead in that issue.
Before you request a review:

Closes #issue_link_here
- 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.
-->

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

**How to review:** <!-- where to start, what to skim -->

**Unsure about:** <!-- where you want a second opinion -->
Comment on lines +17 to +19

@msonnb msonnb Oct 27, 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'd argue that these two could be optional, depending on the change ("Why" on the other hand I think is always relevant). I don't really have a better suggestion though (other than mentioning them in the comment above), so from my end we can just go with it and see if it becomes noisy/unhelpful.

@msonnb msonnb Oct 27, 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.

nevermind, just saw - Remove fields that do not apply (e.g. small PRs). a few lines above 😅


Closes #

<!-- Long, AI-written descriptions at the end, inside `<details><summary>AI walkthrough</summary>...</details>` -->
4 changes: 1 addition & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 #<issue-number>` 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.

Expand Down
Loading