mirror of
https://github.com/Sea-Haven-Industries/shoc-frontend-new.git
synced 2026-09-30 19:43:12 +00:00
The org PR template pre-filled Summary / Validation / Tests / Notes here while PRs in this repository use Summary / Changes and value / Ticket. A repo template now overrides the org one, and the review framework gains the description contract plus a note on the divergence from the org pr-policy workflow, which is not wired in. README: the CI badge tracked the retired dev branch; branches come from main, not dev; the fix/ prefix replaces bug/; staging exists alongside dev; and PRs now merge through the merge queue. Cleanup: four PR description drafts under tmp/ were tracked; they are removed and /tmp/ is ignored.
22 lines
1 KiB
Markdown
22 lines
1 KiB
Markdown
<!--
|
|
Title: type(scope): description (SH-123)
|
|
type is one of feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert, release.
|
|
Product work carries its SH key at the end of the title. Platform or security work carries PLAT or SEC.
|
|
Docs-only and configuration-only chores may omit the key.
|
|
Branch: feature/, fix/, hotfix/, chore/, docs/, refactor/, release/ plus a kebab-case description. No Jira keys in branch names.
|
|
Scope: one logical change per PR. If the title needs "and", split it.
|
|
Body: verifiable facts about the change. No validation transcripts, no deployment notes, no AI attribution footers.
|
|
The layout below is this repository's contract (REVIEW_AND_PR_FRAMEWORK.md, section 8). Keep the three headings.
|
|
-->
|
|
|
|
## Summary
|
|
|
|
<!-- What changed and why, in plain language. Two to four sentences. -->
|
|
|
|
## Changes and value
|
|
|
|
<!-- Grouped by area, each with the value it delivers. Bullets, bold lead-in per bullet. -->
|
|
|
|
## Ticket
|
|
|
|
<!-- The board key(s) this PR delivers, one per line. "None" when nothing applies. -->
|