Skip to content

PR template: Add guidance on a good PR description #3421

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

Open
kensimon wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −3
Open

PR template: Add guidance on a good PR description #3421

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 18 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<!-- Describe what this PR does -->

@kfelternv kfelternv Jul 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should add ## Description header here so its clear where the description goes

@kfelternv kfelternv Jul 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Example where this failed: #3420

<!--
Description: Describe what this PR does, focusing on *why* you are making this
change. What problem is it solving? What motivated making this change? Assume
the audience has no other context: Don't assume people are already aware of
your feature roadmap. If a linked GitHub issue contains the necessary context,
repeat enough of it here to help people understand it at a glance, then link to
it below. PR descriptions are not just for code review, they're also for
helping people understand why a given change happened after it merges. Please
keep both audiences in mind for your PR description.

NOTE: Delete all commented sections like this one before submitting your PR.
-->

## Related issues
<!-- Refer to existing GitHub issues here -->
Expand All @@ -12,8 +23,12 @@
- [ ] **Internal** - Internal changes (refactoring, tests, docs, etc.)

## Breaking Changes
<!-- If checked, describe the breaking changes and migration steps -->
<!-- Breaking changes are not generally permitted, please discuss on a GitHub discussion or with the development team if you believe you need to break a backward compatibility guarantee -->
<!--
If checked, describe the breaking changes and migration steps. Breaking changes
are not generally permitted, please discuss on a GitHub discussion or with the
development team if you believe you need to break a backward compatibility
guarantee
-->
- [ ] **This PR contains breaking changes**

## Testing
Expand Down
Loading