Files
scadaproj/code-reviews
Joseph Doherty fd180e576f docs: point markdown backlogs at Gitea issues (status lives in Gitea)
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).
2026-11-06 15:34:30 -05:00
..

Code Reviews

Comprehensive, per-library code reviews of the ZB.MOM.WW.* shared libraries hosted in this repo. Each library (one self-contained .slnx at the repo root) has its own folder containing a findings.md. This README is the aggregated index — the single place to see all outstanding work.

Generated by regen-readme.py from the per-library findings.md files. Do not edit by hand — edit the findings files and re-run the script.

Status lives in Gitea. Open items from this file are tracked as issues on gitea.dohertylan.com/dohertj2/scadaproj (label migrated, 2026-11-06). This file is a historical/design record — do not track status here; file new work (including new review findings) as an issue.

How it works

  • Reviews are performed one library at a time against a fixed checklist.
  • Each library is reviewed against its normalized component spec under components/.
  • Every finding is recorded in the library's findings.md with a severity and status.
  • Findings are never deleted — they are closed by changing their status, keeping a full audit trail.
  • This README aggregates every pending finding (Open / In Progress) across all libraries.

See REVIEW-PROCESS.md for the full procedure: the review checklist, severity definitions, finding format, the library → component-spec mapping, and how to mark items resolved.

Layout

code-reviews/
├── README.md            # this file — process overview + pending findings
├── REVIEW-PROCESS.md     # how to perform a review and track findings
├── regen-readme.py       # regenerates this README from the findings files
├── _template/findings.md # copy-this template for a library review
└── <Library>/findings.md # one folder per ZB.MOM.WW.* shared library

Summary

6 of 6 libraries reviewed. 0 pending findings across all libraries.

Coverage gap: Secrets, LocalDb, GalaxyRepository and Overview have never been reviewed here, and Auth/Health/Theme have changed substantially since their 2026-06-01 review → #15.

Severity Open findings
Critical 0
High 0
Medium 0
Low 0
Total 0

Library Status

Library Last reviewed Commit Open (C/H/M/L) Open Total
Audit 2026-06-01 5f75cd4 0/0/0/0 0 5
Auth 2026-06-01 5f75cd4 0/0/0/0 0 6
Configuration 2026-06-01 5f75cd4 0/0/0/0 0 4
Health 2026-06-01 5f75cd4 0/0/0/0 0 6
Telemetry 2026-06-01 5f75cd4 0/0/0/0 0 8
Theme 2026-06-01 5f75cd4 0/0/0/0 0 6

Pending Findings

Every Open / In Progress finding across all libraries, highest severity first. Resolved findings drop off this list but remain recorded in their library's findings.md (see REVIEW-PROCESS.md §4–§5). Full detail — description, location, recommendation — lives in the library's findings.md.

Critical (0)

None open.

High (0)

None open.

Medium (0)

None open.

Low (0)

None open.