Joseph Doherty
5f75cd4dab
Adapts the code-reviews convention (process, README generator, template) from the ScadaBridge app model (per-src/-module, Akka conventions) to scadaproj's reality: six shared libraries reviewed against their components/ specs. - REVIEW-PROCESS.md: review unit is a library; library->component-spec mapping; checklist re-targeted for reusable .NET libs (public API/semver, packaging & dependency hygiene, spec/shared-contract adherence) instead of actor/supervision. - _template/findings.md: library/packages/component-spec/shared-contract header. - regen-readme.py: per-library prose, data-driven Summary, '-' for unreviewed. - Seed Auth/Theme/Health/Telemetry/Configuration/Audit findings stubs (0 findings). - README.md generated; --check passes.
72 lines
2.3 KiB
Markdown
72 lines
2.3 KiB
Markdown
# Code Review — <Library>
|
|
|
|
<!--
|
|
Template for a shared-library review. Copy the structure below into
|
|
code-reviews/<Library>/findings.md and fill it in.
|
|
<Library> is the ZB.MOM.WW.* library with the prefix stripped (Auth, Theme,
|
|
Health, Telemetry, Configuration, Audit). See ../REVIEW-PROCESS.md for the
|
|
full process and the library → component-spec mapping.
|
|
-->
|
|
|
|
| Field | Value |
|
|
|-------|-------|
|
|
| Library | `ZB.MOM.WW.<Library>/` |
|
|
| Packages | `<package ids, e.g. ZB.MOM.WW.<Library>>` |
|
|
| Component spec | `components/<component>/spec/SPEC.md` |
|
|
| Shared contract | `components/<component>/shared-contract/ZB.MOM.WW.<Library>.md` |
|
|
| Status | Not yet reviewed \| In progress \| Reviewed |
|
|
| Last reviewed | YYYY-MM-DD |
|
|
| Reviewer | <name> |
|
|
| Commit reviewed | `<short SHA>` |
|
|
| Open findings | 0 |
|
|
|
|
## Summary
|
|
|
|
One short paragraph: overall health of the library, themes across findings, and anything
|
|
notable that is not a finding (e.g. test count, dependency footprint, adoption status).
|
|
|
|
## Checklist coverage
|
|
|
|
Confirm every category was examined. Record "No issues found" where applicable.
|
|
|
|
| # | Category | Examined | Notes |
|
|
|---|----------|----------|-------|
|
|
| 1 | Correctness & logic bugs | ☐ | |
|
|
| 2 | Public API surface & compatibility | ☐ | |
|
|
| 3 | Concurrency & thread safety | ☐ | |
|
|
| 4 | Error handling & resilience | ☐ | |
|
|
| 5 | Security & secret handling | ☐ | |
|
|
| 6 | Performance & resource management | ☐ | |
|
|
| 7 | Spec & shared-contract adherence | ☐ | |
|
|
| 8 | Packaging, dependencies & project layout | ☐ | |
|
|
| 9 | Testing coverage | ☐ | |
|
|
| 10 | Documentation & XML docs | ☐ | |
|
|
|
|
## Findings
|
|
|
|
<!-- One entry per finding. Copy the block below. Never delete a finding; close it
|
|
by changing Status and completing Resolution. -->
|
|
|
|
### <Library>-001 — <Short title>
|
|
|
|
| | |
|
|
|--|--|
|
|
| Severity | Critical \| High \| Medium \| Low |
|
|
| Category | <one of the 10 checklist categories> |
|
|
| Status | Open \| In Progress \| Resolved \| Won't Fix \| Deferred |
|
|
| Location | `ZB.MOM.WW.<Library>/src/<Package>/<File>.cs:<line>` |
|
|
|
|
**Description**
|
|
|
|
What is wrong and why it matters.
|
|
|
|
**Recommendation**
|
|
|
|
Concrete suggested fix.
|
|
|
|
**Resolution**
|
|
|
|
_Unresolved._
|
|
<!-- When closed: fixing commit `<SHA>`, date YYYY-MM-DD, one-line description.
|
|
For Won't Fix / Deferred, justify the decision here. -->
|