dohertj2/scadaproj
1
0
Fork 0
Code Issues 16 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: point markdown backlogs at Gitea issues (status lives in Gitea)

Browse Source 
Adds the family backlog standard to the root index (open work = Gitea issues,
shared label set, BTDB excluded) and converts components/*/GAPS, hosted-lib
CLAUDE.md notes, code-reviews, infra/glauth and plan docs to banner + issue
pointers (scadaproj #5-#19, ScadaBridge#79).
This commit is contained in:
Joseph Doherty
2026-11-06 15:34:30 -05:00
parent 967da5b43b
commit fd180e576f
24 changed files with 123 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/README.md
+8 -3
View File
@@ -51,8 +51,13 @@ Every normalized component is one subfolder of `components/` with this layout:
- **`current-state/<project>/`** is descriptive, not aspirational. It must match the project's
real code, with `file:line` references. Each ends in an **Adoption plan**: what that project
deletes/replaces to reach the spec, and what stays bespoke.
- **`GAPS.md`** is the working backlog: it turns the delta between every `current-state` and the
`spec` into concrete, prioritized items.
- **`GAPS.md`** turns the delta between every `current-state` and the `spec` into concrete,
prioritized items — but **status lives in Gitea** (family standard, 2026-11-06). Open items are
tracked as issues on [`dohertj2/scadaproj`](https://gitea.dohertylan.com/dohertj2/scadaproj/issues)
(the 2026-11-06 sweep filed them with label `migrated`); each GAPS file carries a banner and
`→ #N` pointers next to migrated items, and is otherwise a historical/design record. File new gaps
as issues (family labels `type:*`, `priority:p0..p3`, `blocked`, `cross-repo`) and reference them
from GAPS/current-state docs as `#N` — do not track open/closed status in the markdown.
## Workflow to normalize a component
@@ -66,7 +71,7 @@ Every normalized component is one subfolder of `components/` with this layout:
concrete library API in `shared-contract/`. Keep the surface minimal — extract only what is
genuinely common; leave domain-specific logic in the projects.
4. **Log gaps + adoption.** Fill `GAPS.md` with per-project divergences and an adoption/extraction
backlog (priority / effort / risk). Add the per-project "what to delete/replace" to each
backlog (priority / effort / risk), and file each open item as a Gitea issue (`→ #N` in the file). Add the per-project "what to delete/replace" to each
`current-state` doc.
5. **Register.** Add/maintain the component's row in the registry table above.