76d35d1b9f
Adapts the code-review procedure, folder layout, template, and tooling from the sibling mxaccessgw repo to lmxopcua. - REVIEW-PROCESS.md: per-module review workflow — a module is one src/ or tests/ project (ZB.MOM.WW.OtOpcUa. prefix stripped); 10-category checklist; finding IDs/severities/statuses; re-review rules. - code-reviews/_template/findings.md: per-module findings template. - code-reviews/regen-readme.py: generates the cross-module README.md index from the per-module findings.md files; --check gates staleness and consistency. - code-reviews/test_regen_readme.py: dependency-free generator tests. - code-reviews/prompt.md: orchestration prompt for clearing the backlog. - code-reviews/README.md: generated index (no modules reviewed yet). - scripts/check-code-reviews-readme.ps1: CI / pre-commit check wrapper. Adapted to this repo: ZB.MOM.WW.OtOpcUa module naming, OtOpcUa conventions checklist (in-process GalaxyDriver + mxaccessgw, contained-name vs tag-name, ACL at DriverNodeManager), single .NET solution build/test commands, and the lmxopcua design docs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1.8 KiB
1.8 KiB
Code Review — <Module>
| Field | Value |
|---|---|
| Module | src/<area>/ZB.MOM.WW.OtOpcUa.<Module> |
| Reviewer | |
| Review date | |
| Commit reviewed | <short-sha> |
| Status | Not started |
| Open findings | 0 |
Checklist coverage
A comprehensive review completes every category, recording "No issues found" where a category produced nothing rather than leaving it blank.
| # | Category | Result |
|---|---|---|
| 1 | Correctness & logic bugs | pending |
| 2 | OtOpcUa conventions | pending |
| 3 | Concurrency & thread safety | pending |
| 4 | Error handling & resilience | pending |
| 5 | Security | pending |
| 6 | Performance & resource management | pending |
| 7 | Design-document adherence | pending |
| 8 | Code organization & conventions | pending |
| 9 | Testing coverage | pending |
| 10 | Documentation & comments | pending |
Findings
-001
| Field | Value |
|---|---|
| Severity | Critical / High / Medium / Low |
| Category | one of the 10 checklist categories |
| Location | path/to/File.cs:NN |
| Status | Open / In Progress / Resolved / Won't Fix / Deferred |
Description: What is wrong and why it matters.
Recommendation: Concrete suggested fix.
Resolution: (empty until closed; on close, record the fixing commit SHA, the date, and a one-line description of the fix)