PR template: Add guidance on a good PR description#3421
Open
kensimon wants to merge 1 commit into
Open
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
Summary by CodeRabbit
WalkthroughThe pull request template now includes expanded guidance for writing descriptions and documenting breaking changes. Existing checklist and section structure remains unchanged. ChangesPR Template Guidance
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🔍 Container Scan Summary
Per-CVE detail lives in the per-service |
kfelternv
reviewed
Jul 13, 2026
| @@ -1,4 +1,15 @@ | |||
| <!-- Describe what this PR does --> | |||
Contributor
There was a problem hiding this comment.
Should add ## Description header here so its clear where the description goes
rwthompsonii
approved these changes
Jul 13, 2026
lachen-nv
approved these changes
Jul 14, 2026
chet
approved these changes
Jul 14, 2026
poroh
approved these changes
Jul 14, 2026
yoks
approved these changes
Jul 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We've had a lot of PR's where the description describes what the PR does, but don't give any background on why.
The style guide already outlines this:
So put similar guidance in the pull request template.
Type of Change
Breaking Changes
Testing
Additional Notes