prole/docs/branches/README.md

21 lines
1.0 KiB
Markdown

# Branch reviews
This directory contains review documents for incoming upstream branches before they are merged or cherry-picked into `main`.
Each file corresponds to a review branch created by `scripts/sync_upstream_knoe_db.sh`.
## Index
| Branch | Upstream | Date | Status | Review doc |
|---|---|---|---|---|
| `upstream/knoe-db/20260523` | `git@git.knoe.dev:knoe-dev/knoe-db.git` (`main`) | 2026-05-23 | 🔄 In progress (Task 1 ✅ `57886f9`) | [`upstream-knoe-db-20260523.md`](upstream-knoe-db-20260523.md) |
## How to use these docs
1. Run `scripts/sync_upstream_knoe_db.sh` to fetch upstream and create a dated review branch.
2. A review doc is created here summarising the incoming changes, conflict risk, and recommended actions.
3. Work through the review doc section by section — cherry-pick or copy files as appropriate.
4. When the review is complete, update the Status column above to ✅ Done and note the commit(s) that landed the changes.
See [`docs/upstream-knoe-db-sync.md`](../upstream-knoe-db-sync.md) for the full sync procedure.