adam/engineering-handbook
1
0
Fork 0
mirror of https://github.com/Sea-Haven-Industries/engineering-handbook.git synced 2026-10-03 04:33:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update PR description template to match team format (#4)

Browse source 
Replace Changes/Test Plan sections with Validation/Tests/Notes
to align with the standardized PR format used across all repos.
This commit is contained in:
Adam Moussa 2026-05-08 13:56:21 -04:00 • committed by GitHub
parent e3a4cb8a54
commit 40553157c2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
pull-requests.md
View file

@ -28,14 +28,16 @@ Use a structured format:
```markdown ```markdown
## Summary ## Summary
Brief explanation of what this PR does and why. What changed and why — 1-3 sentences. Explain the motivation, not just the diff.
## Changes ## Validation
- Bullet list of specific changes How you verified it works — steps taken, commands run, screenshots if UI.
## Test Plan ## Tests
- How you verified this works What tests were added, updated, or run. If no automated tests, explain manual testing.
- What to check during review
## Notes
Anything reviewers should know — migration steps, deploy order, follow-ups, breaking changes. Omit this section if empty.
``` ```
The summary should explain **why** the change is needed, not just restate the diff. Reviewers can read the code; they need context. The summary should explain **why** the change is needed, not just restate the diff. Reviewers can read the code; they need context.