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

docs(code-reviews): review Secrets, LocalDb, GalaxyRepository, Overview; re-review changed libs (scadaproj#15)

Browse Source 
First reviews of Secrets, LocalDb, GalaxyRepository and Overview, and
2026-11-09 re-reviews of Auth, Health, Theme, Telemetry, Audit and
Configuration, all at 91fb2b4. 49 new open findings, each with a P1/P2/P3
priority and a failure scenario: 1 P1, 13 P2, 35 P3. README regenerated;
REVIEW-PROCESS, template and regen script now cover all ten libraries and
the Priority field.

Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
This commit is contained in:
Joseph Doherty
2026-11-09 14:33:14 -05:00
parent 91fb2b48dd
commit 477245f5db
14 changed files with 2602 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
code-reviews/REVIEW-PROCESS.md
+8 -2
View File
@@ -3,7 +3,7 @@
This document describes how to perform a comprehensive, per-library code review of the
shared libraries hosted in **scadaproj** and how to track findings to resolution.
scadaproj is an umbrella workspace, but it hosts first-party source: the six
scadaproj is an umbrella workspace, but it hosts first-party source: the
`ZB.MOM.WW.*` shared libraries (the realized output of the
[component normalizations](../components/README.md)). Those libraries are the code that
gets reviewed here. A **library** is one self-contained solution at the repo root (its own
@@ -14,7 +14,7 @@ The review unit is the **library**, not the individual NuGet package. A library
several packages (Auth → 4, Health → 3, Telemetry → 2) is reviewed as a whole; findings
point at the specific package/file in their **Location**.
### The six libraries and their design context
### The libraries and their design context
Each library is reviewed against its normalized component spec. The library folder name is
the `ZB.MOM.WW.` prefix stripped; note the spec directory is **not** always the same word.
@@ -27,6 +27,10 @@ the `ZB.MOM.WW.` prefix stripped; note the spec directory is **not** always the
| `Telemetry` | `ZB.MOM.WW.Telemetry/` | `Telemetry`, `.Serilog` | [`components/observability/`](../components/observability/) |
| `Configuration` | `ZB.MOM.WW.Configuration/` | single | [`components/configuration/`](../components/configuration/) |
| `Audit` | `ZB.MOM.WW.Audit/` | single | [`components/audit/`](../components/audit/) |
| `Secrets` | `ZB.MOM.WW.Secrets/` | `Abstractions`, `Secrets`, `Replicator.SqlServer`, `Replicator.AkkaDotNet`, `Replicator.Grpc`, `Ui`, `Cli` | [`components/secrets/`](../components/secrets/) |
| `LocalDb` | `ZB.MOM.WW.LocalDb/` | see library README | none — [`docs/plans/2026-07-17-localdb-design.md`](../docs/plans/2026-07-17-localdb-design.md) |
| `GalaxyRepository` | `ZB.MOM.WW.GalaxyRepository/` | see library CLAUDE.md | none (design doc 2026-06-23) |
| `Overview` | `ZB.MOM.WW.Overview/` | application (not a package) | none — see `ZB.MOM.WW.Overview/CLAUDE.md` |
## 1. Before you start
@@ -104,6 +108,8 @@ using the entry format in [`_template/findings.md`](_template/findings.md).
public-API / back-compat break, with no safe workaround.
- **Medium** — incorrect or risky behaviour with limited impact or a workaround.
- **Low** — minor issues, style, maintainability, documentation.
- **Priority** (added 2026-11-09) — `P1` (Critical/High), `P2` (Medium), `P3` (Low); the
triage rank used when filing the finding as a Gitea issue.
- **Category** — one of the 10 checklist categories above.
- **Location** — `file:line` (clickable), or a list of locations.
- **Description** — what is wrong and why it matters.