53 lines
2.0 KiB
Markdown
53 lines
2.0 KiB
Markdown
---
|
|
name: evolv-quality-technical-debt
|
|
description: Drive code quality, regression prevention, and technical debt management for EVOLV nodes. Use when reviewing changes for bugs, maintainability, test completeness, architectural drift, and when creating prioritized remediation plans for JavaScript/CommonJS Node-RED modules.
|
|
---
|
|
|
|
# EVOLV Quality Technical Debt
|
|
|
|
## Mission
|
|
Raise delivery reliability by detecting defects early and systematically reducing technical debt in EVOLV nodes.
|
|
|
|
## Scope
|
|
- Node implementation quality in `nodes/<nodeName>/src/`
|
|
- Editor/runtime contract consistency in `.html` + runtime wrappers
|
|
- Shared utility hygiene in `nodes/generalFunctions/`
|
|
- Test depth in `nodes/<nodeName>/test/`
|
|
|
|
## Test Policy Baseline
|
|
All code changes require tests under `nodes/<nodeName>/test/`.
|
|
|
|
Cover at minimum:
|
|
- config default/override behavior and numeric coercion
|
|
- each supported `msg.topic` handler with edge cases
|
|
- child registration and dedupe side effects
|
|
- tick/output boundaries and error paths
|
|
- regression tests for fixed bugs
|
|
|
|
Execution:
|
|
- preferred: `node --test nodes/<nodeName>/test/*.test.js`
|
|
- fallback: `node nodes/<nodeName>/test/<file>.test.js`
|
|
|
|
## Review Workflow
|
|
1. Assess correctness risks first (runtime errors, logic regressions, broken topic contracts).
|
|
2. Assess maintainability (duplication, unclear ownership, implicit behavior).
|
|
3. Assess test adequacy against EVOLV policy:
|
|
- config defaults/overrides
|
|
- topic handlers and edge cases
|
|
- tick/output boundaries
|
|
- regressions for fixed bugs
|
|
4. Create a prioritized debt backlog with effort and impact.
|
|
|
|
## Quality Criteria
|
|
- Domain logic remains testable without full Node-RED runtime.
|
|
- Complex logic is explicit and minimally coupled.
|
|
- Backward compatibility is deliberate and documented.
|
|
- New behavior includes tests that fail before and pass after.
|
|
|
|
## Deliverables
|
|
Return:
|
|
- findings by severity
|
|
- test gaps and specific cases to add
|
|
- debt backlog (now/next/later)
|
|
- recommended refactors with expected payoff
|