docs(contributing): document develop / main branch model

CONTRIBUTING.md gains a "Branch Model" section with an ASCII flow
diagram and the two-rule summary (develop = daily target, main =
release-only). Hotfix flow + end-user-vs-contributor guidance
included. Mirror page on docs.healthlog.dev landed in healthlog-docs
5d96861.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Marc-André BombeckandClaude Opus 4.7 committed 2026-05-10 15:19:05 +02:00
1 parent 77f9741672
commit fe660d407c
3 files changed
+78 -5

No files matched your search

+3 -3
View File
@@ -30,9 +30,9 @@ B1 dispatches.
### F2 — Document branch + release model
- [ ] Extend `CONTRIBUTING.md` with branch flow + ASCII/Mermaid diagram
- [ ] Mirror page on healthlog-docs (developer / contributor docs)
- [ ] Make user-vs-contributor distinction explicit
- [x] Extend `CONTRIBUTING.md` with branch flow + ASCII diagram (this branch)
- [x] Mirror page on healthlog-docs at `/contributing/branch-model/` (`5d96861` on healthlog-docs/main)
- [x] User-vs-contributor distinction explicit in both surfaces
- Detailed report: `.planning/phase-F2-report.md`
### FX — User-facing artifact cleanup (PII + jargon + German leaks)
+47
View File
@@ -0,0 +1,47 @@
# Phase F2 — Document branch + release model
Status: complete · 2026-05-10T15:18+02:00
## Outcome
The two-branch model is documented in two places:
| Surface | File | Audience |
|---|---|---|
| Repo root | `CONTRIBUTING.md` (extended) | Contributors cloning the repo |
| Docs site | `src/content/docs/contributing/branch-model.mdx` | End users + would-be contributors browsing docs.healthlog.dev |
Both contain:
- ASCII branch-flow diagram (`feature/* → develop → main → tag → GHCR → Coolify`)
- Two-rule summary (develop = daily, main = release-only)
- Hotfix flow (branch from main, tag patch, merge back to develop)
- Explicit "end users follow tags / contributors track develop" guidance
## Commits
| Repo | Commit | Branch |
|---|---|---|
| HealthLog | (this commit) | `develop` |
| healthlog-docs | `5d96861` | `main` |
## Build verification
`healthlog-docs`: `npm run build` green, 46 pages built (was 45),
new `/contributing/branch-model/` slug rendered, pagefind search
index covers it.
## Why this lands now (before B-phase work)
The branch model is operational: every B1-B5 commit goes to `develop`.
If the docs lag behind the operational reality, would-be contributors
who clone the repo today and open a PR against `main` would need to
re-target it. Docs ship with F2 so that contract is clear from the
first v1.4.20 commit.
## Sidebar placement
The new "Contributing" sidebar group sits at the bottom of the docs
nav, below "Account". Contains one entry today (`branch-model`); F5
or future hygiene PRs may add `code-conventions`,
`dev-environment`, etc.