Skip to content

Commit 8cfcbc9

Browse files
committed
docs: add branch strategy section to project principles
1 parent 4f705aa commit 8cfcbc9

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

spec/principles.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,22 @@ a last resort. A real fix is always preferred.
117117
- SSL verification is enabled by default.
118118
- All inputs are validated at system boundaries by Pydantic.
119119
- No secrets in logs or error messages.
120+
121+
---
122+
123+
## Branch Strategy
124+
125+
This project uses **Trunk-Based Development** with short-lived branches:
126+
127+
| Branch | Purpose | CI behaviour |
128+
| ------ | ------- | ------------ |
129+
| `main` | Trunk — always deployable production state | Final release via `workflow_dispatch` |
130+
| `feature/*` | New features and bug fixes | PR checks; manual pre-release via `workflow_dispatch` |
131+
| `docs/*` | Documentation-only changes | Change detection skips all CI jobs |
132+
133+
**Rules:**
134+
135+
- All branches merge into `main` via pull request.
136+
- `feature/*` covers both new functionality and bug fixes; no separate `fix/*` or `hotfix/*` branches.
137+
- `docs/*` branches exist solely to skip unnecessary CI; they carry no release privilege.
138+
- Long-lived branches other than `main` are not permitted.

0 commit comments

Comments
 (0)