mirror of
https://github.com/Sea-Haven-Industries/.github.git
synced 2026-09-30 03:43:10 +00:00
Add org-wide pull request template
Codifies the handbook PR description format (Summary/Validation/Tests/ Notes) as the default template GitHub prefills for every repo in the org that lacks its own. Hidden hint comments carry the title, scope, and Jira linking conventions so contributors fill in structure instead of a blank box.
This commit is contained in:
parent
2381907236
commit
204958e8d9
1 changed files with 18 additions and 0 deletions
18
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
18
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
<!--
|
||||
PR conventions — see engineering-handbook/pull-requests.md
|
||||
- Title: imperative mood, under 70 chars, describe the change not the ticket (e.g. "Add receipt parser Lambda", not "PROJ-123" or "Bug fix").
|
||||
- Scope: one logical change per PR. If the title needs an "and", split it.
|
||||
- Jira: put the issue key in the branch name or this PR title (e.g. [PROJ-123]) to link the PR into the Jira issue's development panel. Omit if the work has no ticket.
|
||||
-->
|
||||
|
||||
## Summary
|
||||
<!-- What changed and why — 1-3 sentences. Explain the motivation, not just the diff. -->
|
||||
|
||||
## Validation
|
||||
<!-- How you verified it works — steps taken, commands run, screenshots if UI. -->
|
||||
|
||||
## Tests
|
||||
<!-- What tests were added, updated, or run. If no automated tests, explain the manual testing. -->
|
||||
|
||||
## Notes
|
||||
<!-- Anything reviewers should know: migration steps, deploy order, follow-ups, breaking changes. Delete this section if empty. -->
|
||||
Loading…
Add table
Reference in a new issue