mirror of
https://github.com/Sea-Haven-Industries/shoc-backend.git
synced 2026-09-30 18:53:12 +00:00
Adam Moussa
b7b22a8893
The org PR template pre-filled Summary / Validation / Tests / Notes here while REVIEW_AND_PR_FRAMEWORK.md section 8 prescribes Summary / Changes and value / Ticket. A repo template now overrides the org one, and the framework notes the divergence from the org pr-policy workflow, which is not wired in. README.md orients a reader: environments, architecture in one line, project map, local commands, the governance gate, deployment, and a documentation map. Cleanup: TODO.md is removed because Jira owns work status and its items are stale or done. BACKEND_ARCHITECTURE.md is removed as superseded; the two references now point at git history. .env.example loses its BOM and mojibake dashes. .gitattributes keeps its one active rule.
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. -->
|