1.6 KiB
name, description
| name | description |
|---|---|
| review | Audit the full codebase as a software architect. Score on 5 KPIs (Maintainability, Extensibility, Testability, Robustness, Clarity) and produce docs/review.md. |
Review
Audit the codebase, score each KPI 0–10, and produce docs/review.md.
Process
- Run the test suite to verify baseline health and gather coverage stats.
- Analyze the codebase against the 5 KPIs below.
- Produce
docs/review.mdusing the template inassets/template.md.
KPIs
-
Maintainability — How easily can the system be debugged, modified, or understood? Metrics: modularity, cohesion, coupling, readability, simplicity.
-
Extensibility — How easily can new features be added without major refactoring? Metrics: separation of concerns, dependency injection, use of interfaces/protocols.
-
Testability — How easily can components be tested in isolation and as a whole? Metrics: pure functions, mockability, dependency inversion.
-
Robustness — How well does the system handle edge cases, errors, and real-world conditions? Metrics: state management, predictability, fault tolerance.
-
Clarity — How quickly can a new developer understand the system's design and purpose? Metrics: documentation, consistent naming, clear abstractions.
Rules
- Be specific — cite
file:lineorfile:functionwhen pointing out issues. - No filler — every bullet must be actionable or informative.
- Always include your model/version in the reviewer field.
- Do not modify any code. This is a read-only review.
- Keep the write-up concise.