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.
37 lines
1.0 KiB
Markdown
37 lines
1.0 KiB
Markdown
# Code Review — Telemetry
|
|
|
|
| Field | Value |
|
|
|-------|-------|
|
|
| Library | `ZB.MOM.WW.Telemetry/` |
|
|
| Packages | `ZB.MOM.WW.Telemetry`, `ZB.MOM.WW.Telemetry.Serilog` |
|
|
| Component spec | `components/observability/spec/SPEC.md` |
|
|
| Shared contract | `components/observability/shared-contract/ZB.MOM.WW.Telemetry.md` |
|
|
| Status | Not yet reviewed |
|
|
| Last reviewed | — |
|
|
| Reviewer | — |
|
|
| Commit reviewed | — |
|
|
| Open findings | 0 |
|
|
|
|
## Summary
|
|
|
|
_Not yet reviewed._
|
|
|
|
## Checklist coverage
|
|
|
|
| # | 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
|
|
|
|
_No findings recorded yet._
|