docs: add code review process and baseline review of all 19 modules
Establishes a per-module code review workflow under code-reviews/ and
records the 2026-05-16 baseline review (commit 9c60592): 241 findings
across all src/ modules (6 Critical, 46 High, 100 Medium, 89 Low).
This is the clean starting point for remediation work.
This commit is contained in:
67
code-reviews/_template/findings.md
Normal file
67
code-reviews/_template/findings.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Code Review — <Module>
|
||||
|
||||
<!--
|
||||
Template for a module review. Copy the structure below into
|
||||
code-reviews/<Module>/findings.md and fill it in.
|
||||
See ../REVIEW-PROCESS.md for the full process.
|
||||
-->
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| Module | `src/ScadaLink.<Module>` |
|
||||
| Design doc | `docs/requirements/Component-<Name>.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 module, themes across findings, and
|
||||
anything notable that is not a finding.
|
||||
|
||||
## Checklist coverage
|
||||
|
||||
Confirm every category was examined. Record "No issues found" where applicable.
|
||||
|
||||
| # | Category | Examined | Notes |
|
||||
|---|----------|----------|-------|
|
||||
| 1 | Correctness & logic bugs | ☐ | |
|
||||
| 2 | Akka.NET conventions | ☐ | |
|
||||
| 3 | Concurrency & thread safety | ☐ | |
|
||||
| 4 | Error handling & resilience | ☐ | |
|
||||
| 5 | Security | ☐ | |
|
||||
| 6 | Performance & resource management | ☐ | |
|
||||
| 7 | Design-document adherence | ☐ | |
|
||||
| 8 | Code organization & conventions | ☐ | |
|
||||
| 9 | Testing coverage | ☐ | |
|
||||
| 10 | Documentation & comments | ☐ | |
|
||||
|
||||
## Findings
|
||||
|
||||
<!-- One entry per finding. Copy the block below. Never delete a finding; close it
|
||||
by changing Status and completing Resolution. -->
|
||||
|
||||
### <Module>-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 | `src/ScadaLink.<Module>/<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. -->
|
||||
Reference in New Issue
Block a user